Skip to main content

Documentation

The source of docs.pupilfirst.com is stored in the /docs folder in our Github repo, and is managed using docsify.

The source of developers.pupilfirst.com (this website) is stored in the /docs/developers folder in our Github repo, and is managed using Docusaurus.

Developer documentation#

Simply navigate to the docs/developers folder and run the start command:

cd docs/developers
yarn run start

This should launch the developer documentation in your browser.

Feature documentation#

First, install the docsify CLI globally:

npm i docsify-cli -g

Then serve the docs folder on the desired port.

docsify serve docs -p 3010

The -p option sets the port. Visit localhost:PORT to view docs locally.