Documentalist

A sort-of-static site generator optimized for living documentation of software projects.

Documentation

See the full usage documentation here.

Development

Prerequisites

• Yarn v1.x
• Node v18.x

Dev tasks

• yarn build compiles & builds source code
• yarn lint lints source code
• yarn test runs unit test suites
• yarn deploy pushes docs built in the packages/docs/dist folder to the gh-pages branch

Releases

For maintainers only: