railsdoc.github.io

railsdoc.github.io is yet another Rails API documentation website.

Project Goal

The project goal is making api.rubyonrails.org SEO-friendly.

Additional Goals

There are some enhancements in addition to SEO.

• Built by Jekyll
• Styled by bootstrap(v4)
• No iframe layout
• Table of Contents
• Google Custom Search
• Multiple version documentation
• Mobile-friendly design
• Comment System
• etc. (see. https://github.com/railsdoc/railsdoc.github.io/issues)

Setup

$ bundle install

Build docs

For the latest Rails version:

$ rake build

This command generates Rails docs with default_rails_version defined in _config.yml.

For specific Rails versions:

$ rake build_multi[5.2,6.0,6.1]

Using docker for the older Rails build

Set RUBY_VERSION in .env file and run docker compose.

$ cp .env.sample .env
$ docker compose run app bash -c 'rake build_multi[5.2]'

Serve docs

Serve html under src directory.

$ bundle exec jekyll server

Feature Request

Please create an issue.