Description
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.
Documentation alternatives and similar gems
Based on the "Documentation" category
-
GitHub Changelog Generator
Automatically generate change log from your tags, issues, labels and pull requests on GitHub. -
Annotate
Add a comment documenting the current schema to the top or bottom of each of your ActiveRecord models. -
Asciidoctor
A fast, Ruby-based text processor & publishing toolchain for converting AsciiDoc to HTML5, DocBook, EPUB3, PDF & more. -
Hologram
A markdown based documentation system for style guides. It parses comments in your CSS and helps you turn them into a beautiful style guide. -
YARD
YARD enables the user to generate consistent, usable documentation that can be exported to a number of formats very easily.
* Code Quality Rankings and insights are calculated and provided by Lumnify.
They vary from L1 to L5 with "L5" being the highest. Visit our partner's website for more details.
Do you think we are missing an alternative of Documentation or a related project?
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.
Installation
To get started, you need to add Documentation to your Gemfile and run bundle.
gem 'documentation', '~> 1.0.0'
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.