@blizzbolts/docit v0.11.0

This Project is still under development. Use with caution.

Docit

Simple and Rapid React Documentation https://blizzbolts.github.io/docit

• :stuck_out_tongue: MDX & MD Syntax oriented.
• :tornado: Fast HMR
• :chart: Out of the Box Api & Component Props Table Generation
• :heart: Emoji Support and Responsive Designs

Get Started

This package is ESM only: Node 12+ is needed to use it and it must be imported instead of required.

yarn add @blizzbolts/docit -D

Usage

1. Make your first markdown file under docs

mkdir docs

echo "# Introudction" > docs/index.md

2. Start your doc local dev server by

docit start

For build

docit build

Credits

This project is inspired by Vitepress and Storybook, powered by Vite and MDX

Changelog

CHANGELOG.md

Examples

Docit

Screenshot