[Insert sweet logo here]
A whole world of documentation.
zero-config, pretty, highly discoverable atlas of all your documentation.
Write your docs as usual close to their relevant components and then generate from any* level!
*Works great with monorepos!
Conventions! No config.
Anything under a
docs directory (anywhere) is consumed
README.mdfile can live as a sibling to
docs(it acts as the index file)
.mdas if it was just living in GitHub
.jsexporting a React component to render
.htmlas far as your imagination takes you
docswe'll pull those in too!
How do I customise anything?
For more details on all contributions see CONTRIBUTING.md