Doccoli is a modern lightweight rails engine that provides for management of hierarchical documentation.
Once installed, you'll have a ready-to-use markdown based interface to view as well as edit product documentation on the go. It's nice!
Add this line to your application's Gemfile:
gem 'doccoli'
And then run:
$ bundle
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 doccoli:setup
To populate your database schema and load the initial documentation pages.
bundle exec rake db:migrate doccoli:install_guides
All set!
Now you can (re)start your Rails application and browse to /docs path to view your shiny new documentation system.
Contribution directions go here.
The gem is available as open source under the terms of the MIT License.
FAQs
Unknown package
We found that doccoli demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Fluent Assertions is facing backlash after dropping the Apache license for a commercial model, leaving users blindsided and questioning contributor rights.
Research
Security News
Socket researchers uncover the risks of a malicious Python package targeting Discord developers.
Security News
The UK is proposing a bold ban on ransomware payments by public entities to disrupt cybercrime, protect critical services, and lead global cybersecurity efforts.