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 --fetch antora-playbook.yml
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 --fetch antora-playbook-v1-local.yml
When you are updating or fixing the UI, you may prefer to build it locally without waiting for a release.
To build the UI, clone its repository next to sc-docs:
git clone --branch main https://github.com/spacecubics/sc-docs-ui
After cloning, you will have directories like this:
tree -L 1
.
├── sc-docs
└── sc-docs-ui
Then, you can build the UI assets:
cd sc-docs-ui
npm install
npx gulp build
Build the documentation using the local UI bundle:
cd ../sc-docs
npx antora --fetch antora-playbook.yml --ui-bundle-url ../sc-docs-ui/public/_
The same option works with the single-document local playbooks:
npx antora antora-playbook-v1-local.yml --ui-bundle-url ../sc-docs-ui/public/_
npx antora antora-playbook-a1-local.yml --ui-bundle-url ../sc-docs-ui/public/_
After editing the UI sources, run npx gulp build in sc-docs-ui again
before rebuilding the documentation.