/mdlook

a command-line tool to create HTML docs from Markdown

Primary LanguageGo

MdLook

Beta - Under Development

It provides a command-line interface for converting Markdown files to HTML documentation, with additional features for organizing, processing, and managing your documentation workflow.

chrome_V3t0rbhoW5.mp4

How it Works?

it serve all markdowns. and then render them on client frontend locally. you can serve the output with anything. it using two renderer . the nav renderer that read from nav.md and the markdown renderer that read from your markdowns. and convert them to an html page.

Quick Start

use mdlook init <path> to create workstation

use mdlook watch . on worksation to live reload

use mdlook export on workstation to export your docs as index.html servable.

you can serve the page with any language you prefer. also mdlook provide mdlook serve . for production serve if you want.