History

Chi Wang b2cbf508fb cleanup		2023-09-19 15:29:30 +00:00
..
blog	cleanup	2023-09-19 13:29:52 +00:00
docs	cleanup	2023-09-19 13:29:52 +00:00
src	cleanup	2023-09-19 15:29:30 +00:00
static	cleanup	2023-09-19 12:38:26 +00:00
.gitignore	Deploy a new doc website (#338 )	2021-12-16 17:11:33 -08:00
README.md	update readme	2023-08-27 21:32:15 -04:00
babel.config.js	web-template	2023-08-27 21:30:54 -04:00
docusaurus.config.js	cleanup	2023-09-19 14:24:18 +00:00
package.json	web-template	2023-08-27 21:30:54 -04:00
pydoc-markdown.yml	cleanup	2023-09-16 10:57:57 +00:00
sidebars.js	web-template	2023-08-27 21:30:54 -04:00
yarn.lock	web-template	2023-08-27 21:30:54 -04:00

README.md

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

Local Development

Navigate to the website folder and run:

pydoc-markdown
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.