https://github.com/monix/monix.io
The documentation website.
https://github.com/monix/monix.io
Last synced: over 1 year ago
JSON representation
The documentation website.
- Host: GitHub
- URL: https://github.com/monix/monix.io
- Owner: monix
- License: other
- Created: 2016-01-26T07:17:17.000Z (over 10 years ago)
- Default Branch: main
- Last Pushed: 2023-04-12T06:09:49.000Z (about 3 years ago)
- Last Synced: 2025-01-12T22:10:57.935Z (over 1 year ago)
- Language: HTML
- Homepage: https://monix.io
- Size: 73.8 MB
- Stars: 9
- Watchers: 5
- Forks: 43
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Monix.io
The homepage and the documentation for the Monix project website.
[](https://github.com/monix/monix.io/actions?query=workflow%3Abuild)
## Developing Locally
The website gets generated with [Jekyll](https://jekyllrb.com/) and articles are type-checked with [mdoc](https://github.com/scalameta/mdoc). In order to install the required dependencies:
1. make sure you have a recent Ruby version installed, see for example [rbenv](https://github.com/rbenv/rbenv) for managing Ruby versions, but whatever you can install through your OS's package manager will probably do
2. install [bundler](https://bundler.io/)
3. make sure you have at least Java 8 installed; for managing multiple Java versions see [jenv](http://www.jenv.be/)
4. install [sbt](https://www.scala-sbt.org/)
Then to install the Ruby dependencies of the project:
```
bundle
```
Then to generate the whole website:
```
./script/build
```
### Incremental compilation
To generate the `mdoc`-enabled articles, which takes articles from [./_docs](./_docs), generating them parsed into `./docs`:
```
sbt mdoc
```
You can also watch for changes and do incremental compilation:
```
sbt mdoc --watch
```
You can also generate the docs for a specific version only, e.g. 2.x vs 3.x, since the versions are described as separate sub-modules:
```
sbt docs3x/mdoc --watch
```
To serve the website locally and see what it looks like:
```
bundle exec jekyll serve
```
To build the final website:
```
bundle exec jekyll build
```
N.B. the `sbt mdoc` step does not happen automatically, that's a separate step that needs to be execute as shown above.