You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
zeus
5c40df8054
|
1 year ago | |
---|---|---|
code | 3 years ago | |
docs | 1 year ago | |
.gitignore | 3 years ago | |
LICENSE | 3 years ago | |
README.examples-adoc.md | 3 years ago | |
README.md | 1 year ago | |
antora-update.sh | 3 years ago | |
build-local.sh | 3 years ago | |
build.sh | 3 years ago | |
config | 1 year ago | |
install-appl.sh | 1 year ago | |
push.sh | 3 years ago | |
ui-bundle.zip | 3 years ago |
README.md
swarmlab docs
A swarmlab.io sidecar container.
Docs is a multi-repository documentation site generator (Antora based)
Build from git
git clone https://git.swarmlab.io:3000/docs/docs
or
git clone https://github.com/swarmlab-hybrid/docs.gitcd docs
./build.sh
Install services
Run: ./install-appl.sh
Workflow (Edit -> Preview -> push)
-
Edit antora.yml (This is the main file)
-
Edit modules/
-
You can use a local build first to try out your changes
./build-local.sh
-
Preview the results using your browser
http://172.17.0.2:8080 # ip may be different
ℹ️ When you are satisfied with result push them to the original git repository
push.sh [push comment]
You HAVE to use a string litterall otherwise git will only register the first word!
./push.sh "my push comment"
update antora
./antora-update.sh
examples
see README.examples-adoc.md