Markdown Web Docs

A simple web server to view Markdown documentation with a dynamically generated sidebar for navigation.

Installation

You can install this package globally to use it as a command-line tool:

npm install -g markdown-web-docs

Usage

After installation, you can run the server using the md-serve command followed by the path to your documentation directory:

md-serve /path/to/your/docs

If no path is provided, it will default to ./docs in your current working directory.

The server will start at http://localhost:3000, serving your Markdown files as web pages with a navigation sidebar.

Development

To run the server in development mode with auto-restart on file changes:

npm run dev

Features

• Converts Markdown files to HTML for easy viewing.
• Dynamically generates a sidebar based on the directory structure.
• Supports Mermaid diagrams for visual content (post-processed in the browser).
• Breadcrumb navigation for easy traversal of nested documentation.

License

ISC