Flatdoc is a tiny JavaScript library that builds a documentation site directly from Markdown files, without requiring a server-side engine or static site generator. Point it at a Markdown source and it fetches, parses, and renders content into a ready-to-browse doc layout in the browser. It autogenerates a navigation sidebar from headings, supports anchors, and provides a clean default theme that’s easy to restyle. Because it runs client-side, it’s great for small projects, GitHub-hosted docs, or internal references where you want “drop-in” documentation with minimal setup. The library’s footprint and API are intentionally modest, making it simple to customize templates, typography, or color schemes. For teams who value instant docs from a README or single Markdown file, Flatdoc remains a practical, dependency-light choice.
Features
- Client-side Markdown fetching and rendering to build docs on the fly
- Auto-generated navigation from heading structure
- Clean default styles with straightforward theming hooks
- Works with plain static hosting and GitHub pages
- Anchor links and hash navigation for deep linking within docs
- Minimal JavaScript API and small footprint for quick setup