This is the source code for Space Cubics Documentation Site. It is based on Antora, an open-source static site generator.
In order to build it, you need Antora. You can refer to Antora Documentation how to install and run.
Here is a quick instructions for those who already know.
git clone https://github.com/spacecubics/sc-docs
cd sc-docs
nvm install --lts
npm install
npx antora antora-playbook.yml
Note
Antora does NOT fetch anything if you have your repos already
cached. Make sure to use --fetch if you are rebuilding after any
push or merged upstream.
npx antora --fetch antora-playbook.yml
https://docs.antora.org/antora/latest/playbook/runtime-fetch/#fetch-option
When you are updating or fixing one document set, you may prefer to build only that component.
As an example, to build the SC-OBC Module V1 manual, clone its documentation
repository next to sc-docs:
git clone https://github.com/spacecubics/sc-docs-v1
After clone them, you will have directories like this:
tree -L 1
.
├── sc-docs
└── sc-docs-v1
Then, you can build the documentation using antora-playbook-v1-local.yml:
cd sc-docs
npx antora antora-playbook-v1-local.yml