The Suborbital documentation

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

Using this repository

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).

Prerequisites

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

• Git
• Nodejs version 14 or greater

Clone the git repository by using the below command

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

Running the website locally

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

There are two ways of running the website in development:

npm

cd docs/website
npm install
npm run start

Docker

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

Spellcheck

In order to run spellcheck (the same way that CI runs it), you need to install the following:

macOS:

brew install aspell
pip3 install pyspelling pymdown-extensions

And then run

make spellcheck