mdds v1.0.0

Markdown Documentation Server (mdds)

Fast web server allowing to browse, search and edit project documentation written in Markdown.

Features:

• No configuration needed
• Github-like presentation
• GFM (Github Flavoured Markdown)
• Automatic indexation and search
• Navigation index generation using Markdown extension [[index]]
• In-browser editor

Usage

npm install -g mdds
mdds -o

Your browser will open http://localhost:4040 and display your project documentation.

Command-line options

Usage: mdds [root dir] [options]

Options:
  -p, --port  Port number to listen on       [default: 4040]
  -h, --host  Host address to bind to        [default: "localhost"]
  -o, --open  Open default browser on start
  --help      Show this help

If no root dir is specified, ./ will be used.

Customization

Home page

The server will automatically search for a file named index.md, readme.md or README.md on the specified documentation root and will use it as your home page.

Navigation index

If you insert the text [[index]] in any of your markdown files, it will be replaced by the full navigation index of the markdown files found under the specified root dir. File and folder names will be automatically humanized for better readability.

It is particularly useful on home page to provide an overview of the available documentation for your project.

License

MIT