https://github.com/hyper-systems/hyper-systems.github.io
https://github.com/hyper-systems/hyper-systems.github.io
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/hyper-systems/hyper-systems.github.io
- Owner: hyper-systems
- Created: 2020-11-14T16:01:24.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2023-07-31T10:32:43.000Z (over 2 years ago)
- Last Synced: 2025-03-15T04:44:38.813Z (10 months ago)
- Language: HTML
- Homepage: https://hyper.systems
- Size: 68.4 MB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Hyper public documentation website
The `./docs` folder contains the final static assets to be published.
## Developers documentation
The developers documentation is managed with [Antora](https://antora.org).
The specification of the build process for developers documentation can be
found in the `./antora` folder.
### Adding documentation components
Currently the workflow for adding external documentaiton components is:
1. Clone the desired git repository into `./antora/sources/repo-name`.
- Note: the sources folder is part of `.gitignore`.
2. Add the new source to `./antora/antora-playbook.yml` file in the `sources` section.
3. Build the documentation from the `./antora` folder:
- `make build`
#### Modifying the UI
Setup the UI build entironment:
- `cd ./antora/antora-ui-default`
- `npm install`
Build the theme bundle:
- `npx gulp bundle`
After this the documentation can be built normally:
- `npx antora generate antora-playbook.yml`