https://github.com/adamcooke/documentation

A Rails engine to provide the ability to add documentation to a Rails application
https://github.com/adamcooke/documentation

Last synced: 17 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/adamcooke/documentation
• Owner: adamcooke
• License: mit
• Archived: true
• Created: 2014-07-11T17:19:52.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2023-01-20T07:25:12.000Z (almost 2 years ago)
• Last Synced: 2024-08-01T17:36:36.390Z (4 months ago)
• Language: Ruby
• Homepage:
• Size: 181 KB
• Stars: 215
• Watchers: 7
• Forks: 38
• Open Issues: 22
• Metadata Files:
  • Readme: README.md
  • License: MIT-LICENSE

Awesome Lists containing this project

• awesome-ruby - Documentation - A Rails engine to provider the ability to add documentation to a Rails application. (Documentation)

README

        
# 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](http://s.adamcooke.io/14/VGaMe.png)

## Installation

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

```ruby

gem 'documentation', '~> 1.0.0'

```

[![Gem Version](https://badge.fury.io/rb/documentation.svg)](http://badge.fury.io/rb/documentation)

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.