Minimalist project documentation web app runtime. Create interactive docs, generated on the fly from your markdown files.
Features:
- Zero config
- Zero build โ you only need a simple
index.html
and content is generated on the fly from your markdown files - Lightweight-ish โ gzip'd 16kB of JS and 4kB of CSS, mostly the markdown parser
- Works with any web server โ uses hash based routing so no special server configuration required
- Simple, functional, and friendly UX
Check out our docs, visit https://microdoc.js.org.
Recent versions of evergreen browsers. Our build target is:
- Chrome 55
- Edge 18
- Firefox 53
- Safari 11
See old browser support in our docs.
Please report any bugs you encounter on the GitHub issue tracker.
See releases on GitHub.
MIT license. See LICENSE.
The blue book icon is from twitter/twemoji which is licensed CC-BY 4.0.
ยฉ 2023 Max Milton