Skip to content
This repository has been archived by the owner on Dec 15, 2022. It is now read-only.
/ documentation Public archive
forked from adamcooke/documentation

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

License

Notifications You must be signed in to change notification settings

shypple/documentation

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

71 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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.

About

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

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Ruby 77.9%
  • HTML 17.3%
  • CSS 2.4%
  • JavaScript 2.4%