Codex Server
Codex is a markdown wiki server with mathjax and syntax highlighting.
How it works
The codex server works as web server for local files inside a directory and its subdirectories. Codex will render each filetype with a nice customizable webpage template.
Configuration
To quickly create a new configuration file, run the command codex create config. This will create the file .codex-data/config/default.json and add a basic configuration:
{
"server-title" : "Untitled Codex",
"views-path" : "/Users/james/dev/codex/codex-classic-theme/views/",
"modules" : [
{
"name" : "codex-classic-theme",
"module" : "../codex-classic-theme"
}
]
}Starting
To start the server, navigate to the root folder of your file hierarchy and run the command: codex start to start the program.
Press Ctrl + c to stop the process.
Templates
For nice looking pages, you will need to place a templates folder called views/ in the root of your hierarchy. In this folder place .html or .ejs files for each type of template:
-
index.html- This is the main template for rendering most pages (like markdown). Add<%- body %>somewhere in this file for rendering content passed from codex. -
error-404.html- A basic error page template.
Restarting the server is not required when changing templates.
Development
Details and ideas about the development of codex-server.
Resources
-
Auth0 – External user manager and authentication.
-
express-ejs-layout using different layout – Use different themes.
-
Notion Icons 2.0 – alternative icons that maybe could be used for this app.
-
The Top 42 Notion Open Source Projects – Projects related to Notion that could be a source of inspiration for this project.
-
How to create an SQLite database in node.js – Embed a database inside codex-server.
-
Bootstrap v5 and icons
-
app.set('views', path.join(__dirname, '../views'))
Codex Server – create by James Peret – 2017