NodeJS server that renders markdown files to HTML and serves them
If you find the project useful, please consider supporting, or contributing.
This server treats .md
files as if they were standard .html
files, except it renders markdown before serving. The root is /public
folder, so feel free to clear it, then add a index.md
file to any folder, just as if you were using index.html
files. Every other file type is served normally.
By default, each rendered markdown file is cached and only recompiled if the file has changed. Caching yields between 2 and 4 times performance improvement with smaller markdown files, this will increase as they get bigger.
Edit config.yml
to change settings before deployment or container building.
This project uses yarn
for package management.
Refer to .nvmrc for node version.
Start using docker-compose
docker-compose up --build
Build container manually
make container
make run
make deploy
make start
make install
make