You can use the ./plano
command in the root of the project to
perform project tasks. It accepts a subcommand. Use ./plano --help
to list the available commands.
You can use the ./plano render
command in the root of the project to
render the site:
$ ./plano render
--> render
Rendering input files
<-- render
OK (0.21s)
For development, you can serve the site locally. Any changes you make to the input files are rendered on demand.
$ ./plano serve
--> serve
Rendering input files
Watching for input file changes
Serving at http://localhost:8080
Starting LiveReload v0.9.1 for /home/jross/code/skupper-website-ssorj/output on port 35729.
The docs source is in a distinct repo, skupper-docs and are written in AsciiDoc.
The process of publishing these docs to the Skupper website uses Antora to convert them to HTML.
- Install Antora.
- Run
./plano generate-docs
to create HTML from themaster
branch ofskupper-docs
. - Run
./plano test
to run tests and populate thedocs
directory of this repo with the HTML files from step 1.