https://github.com/dubniczky/markbook
NodeJS server that renders markdown files as HTML and serves them
https://github.com/dubniczky/markbook
markdown markdown-renderer web-server website
Last synced: 2 months ago
JSON representation
NodeJS server that renders markdown files as HTML and serves them
- Host: GitHub
- URL: https://github.com/dubniczky/markbook
- Owner: dubniczky
- License: mit
- Created: 2022-07-21T10:14:31.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2026-02-01T15:21:39.000Z (5 months ago)
- Last Synced: 2026-02-02T00:39:41.093Z (5 months ago)
- Topics: markdown, markdown-renderer, web-server, website
- Language: CSS
- Homepage:
- Size: 62.5 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# Markbook
NodeJS server that renders markdown files to HTML and serves them
## Description
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.
## Requirements
This project uses `yarn` for package management.
Refer to [.nvmrc](./.nvmrc) for node version.
## Usage
### Container
Start using docker-compose
```bash
docker-compose up --build
```
Build container manually
```bash
make container
make run
```
### Local Host
```bash
make deploy
make start
```
### Development mode
```bash
make install
make
```