microdoc

Minimalist zero-config zero-build project documentation web apps.

Usage no npm install needed!

<script type="module">
  import microdoc from 'https://cdn.skypack.dev/microdoc';
</script>

README

Build status Coverage status NPM version NPM bundle size (minified + gzip) License

microdoc

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

Usage

Check out our docs, visit https://microdoc.js.org.

Browser support

Recent versions of evergreen browsers. Our build target is:

  • Chrome 55
  • Edge 18
  • Firefox 53
  • Safari 11

See old browser support in our docs.

Bugs

Please report any bugs you encounter on the GitHub issue tracker.

Changelog

See releases on GitHub.

License

MIT license. See LICENSE.

The blue book icon is from twitter/twemoji which is licensed CC-BY 4.0.

© 2022 Max Milton