This repository contains the documentation for all projects under Suborbital. We are so glad that you want to contribute!

You can preview, use, and edit this repository locally using Docusaurus. We use Docusaurus v2 and you would need the below listed prerequisites installed locally to use the repository. Note: Docusaurus is automatically installed as a Nodejs module (see below).

To use this repository, please ensure you have the following installed before you start

• Git
• Nodejs version 14 or greater
• Yarn (optional, but good to have)

Clone the git repository by using the below command

git clone https://github.com/suborbital/docs.git

Navigate to the docs/website folder and start up the website.

There are three ways of building and running the website:

cd docs/website
npm install
npm run build
npm run serve

cd docs/website
yarn
yarn run start

docker build . -t subo/docs
docker run -p 8080:80 subo/docs

After the second command, you won't see any output, but can open the docs at localhost:8000