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.
Alternatively, view Documentation alternatives based on common mentions on social networks and blogs.
-
GitHub Changelog Generator
Automatically generate change log from your tags, issues, labels and pull requests on GitHub. -
Asciidoctor
:gem: A fast, open source text processor and publishing toolchain, written in Ruby, for converting AsciiDoc content to HTML 5, DocBook 5, and other formats. -
-
Hologram
A markdown based documentation system for style guides. -
rspec_api_documentation
Automatically generate API documentation from RSpec -
grape-swagger
Add OAPI/swagger v2.0 compliant documentation to your grape API -
RDoc
RDoc produces HTML and online documentation for Ruby projects. -
Doctor
Doctor is a Documentation Server for all your docs in github. -
-
Hanna
RDoc generator designed with simplicity, beauty and ease of browsing in mind
Collect and Analyze Billions of Data Points in Real Time
* Code Quality Rankings and insights are calculated and provided by Lumnify.
They vary from L1 to L5 with "L5" being the highest.
Do you think we are missing an alternative of Documentation or a related project?
|
Clean code begins in your IDE with SonarLint
sponsored
www.sonarlint.org
|
Popular Comparisons
-
DocumentationvsApidoco
-
Documentationvsgrape-swagger
-
DocumentationvsApipie
-
DocumentationvsGitHub Changelog Generator
-
Documentationvsrspec_api_documentation
|
Tired of breaking your main and manually rebasing outdated pull requests?
sponsored
blog.mergify.com
|
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.