Files
autogen/website/README.md
Jack Gerrits 276d5b7d31 docs: initial Jupyter support for website docs, move config notebook (#1448)
* docs: jupyter support for website docs, move config docs

* update devcontainer dockerfile, fix CI issues

* update bsed on working directory

* update TLDR

* install into temp

* remove unrelated change from diff

* fix spelling issue

* Update sidebars.js
2024-01-30 22:54:44 +00:00

931 B

Website

This website is built using Docusaurus 2, a modern static website generator.

Prerequisites

To build and test documentation locally, begin by downloading and installing Node.js, and then installing Yarn. On Windows, you can install via the npm package manager (npm) which comes bundled with Node.js:

npm install --global yarn

Installation

pip install pydoc-markdown
cd website
yarn install

Install Quarto

quarto is used to render notebooks.

Install it here.

Local Development

Navigate to the website folder and run:

pydoc-markdown
quarto render ./docs
yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.