A rest api documentation generator for rails applications using markdown
The purpose of documentation zero is to generate a scaffold for rails api documentations using markdown.
You can see an example of the generated documentation here.
Add this line to your application’s Gemfile:
gem "documentation-zero"
rails generate documentation:readme
rails generate documentation:scaffold posts title:string body:text published:boolean user:references
Add - [Posts](sections/posts.md) to API endpoints section.
To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.
Bug reports and pull requests are welcome on GitHub at https://github.com/lazaronixon/documentation-zero. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.
The gem is available as open source under the terms of the MIT License.
Everyone interacting in the DocumentationZero project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.