{"id":20059697,"url":"https://github.com/monix/monix.io","last_synced_at":"2025-03-02T09:44:33.115Z","repository":{"id":3711573,"uuid":"50411009","full_name":"monix/monix.io","owner":"monix","description":"The documentation website.","archived":false,"fork":false,"pushed_at":"2023-04-12T06:09:49.000Z","size":77346,"stargazers_count":9,"open_issues_count":6,"forks_count":43,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-01-12T22:10:57.935Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://monix.io","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/monix.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-01-26T07:17:17.000Z","updated_at":"2024-05-17T16:44:15.000Z","dependencies_parsed_at":"2022-08-19T10:02:12.273Z","dependency_job_id":null,"html_url":"https://github.com/monix/monix.io","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/monix%2Fmonix.io","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/monix%2Fmonix.io/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/monix%2Fmonix.io/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/monix%2Fmonix.io/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/monix","download_url":"https://codeload.github.com/monix/monix.io/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241488156,"owners_count":19970827,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-13T13:08:53.798Z","updated_at":"2025-03-02T09:44:33.097Z","avatar_url":"https://github.com/monix.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Monix.io\n\nThe homepage and the documentation for the Monix project website.\n\n[![Build status](https://github.com/monix/monix.io/workflows/build/badge.svg)](https://github.com/monix/monix.io/actions?query=workflow%3Abuild)\n\n## Developing Locally\n\nThe 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:\n\n1. 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\n2. install [bundler](https://bundler.io/)\n3. make sure you have at least Java 8 installed; for managing multiple Java versions see [jenv](http://www.jenv.be/)\n4. install [sbt](https://www.scala-sbt.org/)\n\nThen to install the Ruby dependencies of the project:\n\n```\nbundle\n```\n\nThen to generate the whole website:\n\n```\n./script/build\n```\n\n### Incremental compilation\n\nTo generate the `mdoc`-enabled articles, which takes articles from [./_docs](./_docs), generating them parsed into `./docs`:\n\n```\nsbt mdoc\n```\n\nYou can also watch for changes and do incremental compilation:\n\n```\nsbt mdoc --watch\n```\n\nYou 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:\n\n```\nsbt docs3x/mdoc --watch\n```\n\nTo serve the website locally and see what it looks like:\n\n```\nbundle exec jekyll serve\n```\n\nTo build the final website:\n\n```\nbundle exec jekyll build\n```\n\nN.B. the `sbt mdoc` step does not happen automatically, that's a separate step that needs to be execute as shown above.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmonix%2Fmonix.io","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmonix%2Fmonix.io","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmonix%2Fmonix.io/lists"}