@brisk-docs/website

Brisk Docs website generator

Brisk Docs is a package oriented documentation system that lets you write useful, interactive docs alongside your code.

Getting started

Start by installing Brisk Docs in your project

npm install @brisk-docs/website

To start your docs website locally, simply run:

npm run brisk dev

To produce a static build of the website that can be hosted:

npm run brisk export:

Organising your documentation

Brisk Docs by default uses file and folder name conventions to find docs in your codebase and display them in a organised way.

Project level documentation

For guides and docs relating to your project or repository as a whole, Brisk Docs will display any Markdown or MDX files placed in the /docs folder at the top of your repository. This is a good place to put user guides, tutorials, contributor guidelines etc.

Package level documentation

Brisk Docs has first class support for multi-package repos. All packages found in the /packages directory of your project will have documentation generated automatically.

Read more about package documentation in our package documentation guide.