|
| 1 | +title: Read the Docs ❤️ Ruby |
| 2 | +date: 2024-03-05 |
| 3 | +category: Feature announcement |
| 4 | +tags: builders, tools |
| 5 | +authors: Manuel Kaufmann |
| 6 | +status: published |
| 7 | +image: /images/read-the-docs-loves-ruby.jpg |
| 8 | +image_credit: Photo by <a href="https://unsplash.com/@jasondeblooisphotography?utm_content=creditCopyText&utm_medium=referral&utm_source=unsplash">Jason D</a> on <a href="https://unsplash.com/photos/selective-focus-photo-of-red-gemstone-VKLJ-BJlszE?utm_content=creditCopyText&utm_medium=referral&utm_source=unsplash">Unsplash</a> |
| 9 | + |
| 10 | + |
| 11 | +We are happy to announce that **support for Ruby is now available** as an option for our pre-defined building tools ([`build.tools`](https://docs.readthedocs.io/en/stable/config-file/v2.html#build-tools)). |
| 12 | +Projects requiring Ruby to build their documentation are officially supported on Read the Docs 🎉 |
| 13 | + |
| 14 | +## Demo project using Jekyll |
| 15 | + |
| 16 | +As an example of a project using Ruby, [see a demo of the default Jekyll blog](https://test-builds.readthedocs.io/en/jekyll/) built and hosted on Read the Docs. |
| 17 | +The following code is the `.readthedocs.yaml` configuration file used to build it: |
| 18 | + |
| 19 | + |
| 20 | +```yaml |
| 21 | +version: 2 |
| 22 | + |
| 23 | +build: |
| 24 | + os: ubuntu-22.04 |
| 25 | + tools: |
| 26 | + ruby: "3.3" |
| 27 | + commands: |
| 28 | + - gem install bundle |
| 29 | + - bundle install |
| 30 | + - jekyll build --destination $READTHEDOCS_OUTPUT/html |
| 31 | +``` |
| 32 | +
|
| 33 | +As you can see, it's pretty simple to use Read the Docs with Ruby |
| 34 | +and install dependencies with `gem` and `bundle` following the community standard patterns. |
| 35 | + |
| 36 | + |
| 37 | +## More documentation tools supported |
| 38 | + |
| 39 | +With the support for Ruby, a new door is opened for projects requiring documentation tools that weren't supported on Read the Docs before, |
| 40 | +like [Jekyll](https://jekyllrb.com/), [Asciidoctor](https://asciidoctor.org/), [yard](https://yardoc.org/), [rdoc](https://ruby.github.io/rdoc/), and many others. |
| 41 | + |
| 42 | + |
| 43 | +## Try it out and give us feedback |
| 44 | + |
| 45 | +We encourage you to give Read the Docs a try if you are using any of these documentation tools, |
| 46 | +and take advantage of the extra features we provide to empower your documentation workflow, |
| 47 | +like [pull request previews](https://docs.readthedocs.io/en/stable/pull-requests.html) and [Git-based versioning](https://docs.readthedocs.io/en/stable/versions.html). |
| 48 | + |
| 49 | +Please [let us know](mailto:[email protected]) how your experience is with any of these Ruby documentation tools, and how we might improve our support. |
0 commit comments