Skip to content
The documentation website.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
_includes
_layouts
_plugins
_posts
_tut/docs
api
blog
presentations
project
public
scripts
src/main/scala/io/monix/website
.gitignore Enable comments on the presentation pages Nov 10, 2018
.java-version Fixes for upcoming 2.1 announcement Nov 10, 2016
.nojekyll
.sbtopts
.travis.yml
404.html
CNAME
Gemfile
Gemfile.lock
LICENSE.md
README.md
_config.yml
build.sbt
favicon.ico
index.md
manifest.json
privacy.md
robots.txt
social.md

README.md

Monix.io

The homepage and the documentation website for the Monix project.

Travis

Generating the Website Locally

The website gets generated with Jekyll and articles are type-checked with tut. In order to install the required dependencies:

  1. 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
  2. install bundler
  3. make sure you have at least Java 8 installed; for managing multiple Java versions see jenv
  4. install sbt

Then to install the Ruby dependencies of the project:

bundle

To generate the tut-enabled articles, which takes articles from ./_tut and drops them parsed in ./docs:

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

N.B. the tut / sbt step does not happen automatically, that's a separate step that needs to be execute as shown above.

You can’t perform that action at this time.