iona-doc

0.1.1 • Public • Published

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)

Versions

Current Tags

  • Version
    Downloads (Last 7 Days)
    • Tag
  • 0.1.1
    0
    • latest

Version History

  • Version
    Downloads (Last 7 Days)
    • Published
  • 0.1.1
    0
  • 0.1.0
    0

Package Sidebar

Install

npm i iona-doc

Weekly Downloads

0

Version

0.1.1

License

MIT

Unpacked Size

867 kB

Total Files

61

Last publish

Collaborators

  • kamikat