roboquant website

This repo contains the content for the roboquant.org website. It uses JBake as the generator for the static website and AsciiDoc for most of the documentation. All the Kotlin code samples used in the documentation are in the samples directory and can be compiled to make sure they are correct and still up to date.

Check the roboquant site at roboquant.org

Build

To generate the website (output will be in the ./build directory), run:

mvn jbake:generate

If you also want to validate if the included code snippets (found in the ./samples directory) still compile, you can run:

mvn compile

ℹ️	If you are on Apple Silicon (the M1 processor), the default JBake installation won’t work. But the JBake Maven plugin used in this project has an upgraded version of the OrientDB library that should work (but not very well tested).

To interactively develop, you can run:

mvn jbake:inline

Deploy

The https://roboquant.org site is actually a GitHub Pages website. Using the action as defined in .github/workflows/gh-pages.yml, the static content for the website is automatically generated and deployed after each new push on the main branch. So there is no need for a manual step to update the website after a change has been committed to this repository.

Other

If you want to fork this for your own website, please be aware that some templates still have hard coded content in there that you want to replace.