https://github.com/maxmilton/microdoc

📘 Minimalist zero-config zero-build project documentation web apps.
https://github.com/maxmilton/microdoc

docs documentation html markdown zero-configuration zeroconf

Last synced: 3 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/maxmilton/microdoc
• Owner: maxmilton
• License: mit
• Created: 2021-04-14T00:22:07.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2024-10-27T00:05:47.000Z (3 months ago)
• Last Synced: 2024-10-27T01:19:33.283Z (3 months ago)
• Topics: docs, documentation, html, markdown, zero-configuration, zeroconf
• Language: TypeScript
• Homepage: https://microdoc.js.org
• Size: 1.97 MB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Build status](https://img.shields.io/github/actions/workflow/status/maxmilton/microdoc/ci.yml?branch=master)](https://github.com/maxmilton/microdoc/actions)

[![Coverage status](https://img.shields.io/codeclimate/coverage/MaxMilton/microdoc)](https://codeclimate.com/github/MaxMilton/microdoc)

[![NPM version](https://img.shields.io/npm/v/microdoc.svg)](https://www.npmjs.com/package/microdoc)

[![NPM bundle size (minified + gzip)](https://img.shields.io/bundlephobia/minzip/microdoc.svg)](https://bundlephobia.com/result?p=microdoc)

[![License](https://img.shields.io/github/license/maxmilton/microdoc.svg)](https://github.com/maxmilton/microdoc/blob/master/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 .

## 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](https://microdoc.js.org/#/advanced/old-browser-support.md).

## Bugs

Please report any bugs you encounter on the [GitHub issue tracker](https://github.com/maxmilton/microdoc/issues).

## Changelog

See [releases on GitHub](https://github.com/maxmilton/microdoc/releases).

## License

MIT license. See [LICENSE](https://github.com/maxmilton/microdoc/blob/master/LICENSE).

The [blue book icon](https://github.com/twitter/twemoji/blob/master/assets/svg/1f4d8.svg) is from [twitter/twemoji](https://github.com/twitter/twemoji) which is licensed CC-BY 4.0.

---

© 2023 [Max Milton](https://maxmilton.com)