The homepage and the documentation website for the Monix project.
Generating the Website Locally
- make sure you have a recent Ruby version installed, see for example RVM for managing Ruby versions, but whatever you can install through your OS's package manager will probably do
- install bundler
- make sure you have at least Java 8 installed; for managing multiple Java versions see jenv
- install sbt
Then to install the Ruby dependencies of the project:
To generate the
tut-enabled articles, which takes articles from
./_tut and drops them parsed in
sbt -J-Xmx4096m -J-XX:MaxMetaspaceSize=2048m run
N.B. the memory settings are there because we are downloading and loading up specific library dependencies per article, which can yield "metaspace" problems.
To serve the website locally and see what it looks like:
bundle exec jekyll serve
To build the final website:
bundle exec jekyll
sbt step does not happen automatically, that's a separate step that needs to be execute as shown above.