Repository files navigation

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

The project goal ismakingapi.rubyonrails.org SEO-friendly.

There are some enhancements in addition to SEO.

• Built byJekyll
• Styled bybootstrap(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)

$bundle install

For the latest Rails version:

$rake build

This command generates Rails docs withdefault_rails_version defined in_config.yml.

For specific Rails versions:

$rake build_multi[5.2,6.0,6.1]

SetRUBY_VERSION in.env file and rundocker compose.

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

Serve html undersrc directory.

$bundleexec jekyll server

Please create anissue.