History

Vijaya Lakshmi Venkatraman a89efb552f Update Contribute.md (#716 ) Co-authored-by: Qingyun Wu <qingyun.wu@psu.edu>		2022-09-08 00:20:23 -04:00
..
blog	Deploy a new doc website (#338 )	2021-12-16 17:11:33 -08:00
docs	Update Contribute.md (#716 )	2022-09-08 00:20:23 -04:00
src	data in csv (#430 )	2022-01-30 19:36:41 -08:00
static	update browser icon (#407 )	2022-01-15 14:44:42 -08:00
.gitignore	Deploy a new doc website (#338 )	2021-12-16 17:11:33 -08:00
README.md	Deploy a new doc website (#338 )	2021-12-16 17:11:33 -08:00
babel.config.js	Deploy a new doc website (#338 )	2021-12-16 17:11:33 -08:00
docusaurus.config.js	url update for doc edit	2021-12-18 15:00:54 -08:00
package.json	update node forge	2022-07-21 15:09:22 -04:00
pydoc-markdown.yml	Deploy a new doc website (#338 )	2021-12-16 17:11:33 -08:00
sidebars.js	Finish the Multiple Choice Classification (#367 )	2022-01-02 20:12:34 -05:00
yarn.lock	update node forge	2022-07-21 15:09:22 -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.