iona-doc

Lightweight library for creating interactive docs (inspired by docz).

Usage no npm install needed!

<script type="module">
  import ionaDoc from 'https://cdn.skypack.dev/iona-doc';
</script>

README

Iona

Lightweight library for creating interactive docs (inspired by docz).

  • MDX for interactive markdown document.
  • Native create-react-app project.
  • Out-of-box syntax highlight with Prism.js.
  • Minimal package size (~35MB) with dependencies.

Installation

As project dependency (for standalone document project):

yarn add iona-doc

As development dependency (for general-purpose project):

yarn add --dev iona-doc

See Getting Started for more information.

Documentation

You can find documentation on the GitHub page.

Roadmap

  • Header anchors
  • Customizable styles
  • Nav-item styles
  • Responsive-ness

License

(The MIT License)