The documentation website.
Branch: master
Clone or download
Avasil Add Section for Scheduling with Observable (#55)
* Add Section for Scheduling with Observable

* Add Section for Scheduling with Observable

* tut fixes
Latest commit 0a95049 Feb 8, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
_includes Add analytics, privacy policy Jan 12, 2019
_layouts Add analytics, privacy policy Jan 12, 2019
_plugins New Youtube presentations Nov 12, 2018
_posts New Youtube presentations Nov 12, 2018
_tut/docs Add Section for Scheduling with Observable (#55) Feb 8, 2019
api 3x scaladoc update Nov 6, 2018
blog Add raw video links Nov 8, 2018
presentations Fix wording Dec 19, 2018
project Series/3.x (#27) Mar 19, 2018
public Resize image Dec 19, 2018
scripts Disable synchronization to server via rsync Oct 22, 2018
src/main/scala/io/monix/website Update Scala version, add scalacOptions Nov 13, 2018
.gitignore Enable comments on the presentation pages Nov 10, 2018
.java-version Fixes for upcoming 2.1 announcement Nov 10, 2016
.nojekyll Add .nojekyll Dec 19, 2018
.sbtopts Series/3.x (#27) Mar 19, 2018
.travis.yml Disable synchronization to server via rsync Oct 22, 2018
404.html Initial commit May 18, 2016
CNAME Initial commit May 18, 2016
Gemfile Remove duplicate nokogiri entry from Gemfile (#32) Mar 26, 2018
Gemfile.lock Update deps Nov 6, 2018
LICENSE.md Add github-stars, new blog post Mar 19, 2018
README.md Series/3.x (#27) Mar 19, 2018
_config.yml Add .nojekyll Dec 19, 2018
build.sbt Update Scala version, add scalacOptions Nov 13, 2018
favicon.ico New logo Oct 14, 2016
index.md Update version on website, update ScalaDoc for 3.0 (#53) Nov 6, 2018
manifest.json Refactoring, optimizations, add cancelable.html May 26, 2016
privacy.md Enable CF sse Jan 12, 2019
robots.txt Initial commit May 18, 2016
social.md Add analytics, privacy policy Jan 12, 2019

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.