Skip to content

Docs

Documents are generated using deno task docs command.

Jurassic extracts markdown and exported code signatures from notebooks and converts them into a doc site powered by Vitepress. CI script is included to host documentation using Github pages. docs directory includes Vitepress specific files that you can modify to tweak documentation site

To get docs to work on Github: head to repository Settings > Pages and Select GitHub Actions as Source

generateDocs

typescript
const generateDocs = (config: Config) => Promise<void>