documentation

by adamcooke

adamcooke / documentation

A Rails engine to provide the ability to add documentation to a Rails application

213 Stars 39 Forks Last release: Not found MIT License 70 Commits 0 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

Documentation

Documentation is a Rails engine which provides a complete system for managing a set of hierarchical documentation. Once installed in an application, you'll have a complete user interface for viewing as well as editing a set of markdown pages.

Screenshot

Installation

To get started, you need to add Documentation to your Gemfile and run

bundle
.
gem 'documentation', '~> 1.0.0'

Gem Version

Next, you'll need to run the setup generator which will add a route to your

config/routes.rb
file for the Documentation interface.
bundle exec rails generate documentation:setup

You now need to populate your database schema and load the initial documentation pages.

bundle exec rake db:migrate documentation:install_guides

Once this is done, you can go ahead and start up your Rails application and browse to

/docs
to view your documentation system.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.