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 68eb616009 ui 3 years ago
code antora 3 years ago
docs ui 3 years ago
.gitignore add gitignore build 3 years ago
LICENSE Initial commit 3 years ago
README.examples-adoc.md tools 3 years ago
README.md tools 3 years ago
antora-update.sh docker tools 3 years ago
build-local.sh tools 3 years ago
build.sh tools 3 years ago
push.sh edited README 3 years ago
ui-bundle.zip ui 3 years ago

README.md

swarmlab docs

Build from git

git clone https://git.swarmlab.io:3000/docs/docs
cd docs
./build.sh

Workflow (Edit -> Preview -> push)

  1. Edit antora.yml (This is the main file)

  2. Edit modules/

  3. You can use a local build first to try out your changes

    ./build-local.sh

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