Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lazaronixon/documentation-zero
A rest api documentation generator for rails applications using markdown
https://github.com/lazaronixon/documentation-zero
api-rest documentation generator rails rest
Last synced: 10 days ago
JSON representation
A rest api documentation generator for rails applications using markdown
- Host: GitHub
- URL: https://github.com/lazaronixon/documentation-zero
- Owner: lazaronixon
- License: mit
- Created: 2022-03-18T06:12:46.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2022-04-26T11:59:27.000Z (over 2 years ago)
- Last Synced: 2024-04-26T13:20:39.578Z (7 months ago)
- Topics: api-rest, documentation, generator, rails, rest
- Language: Ruby
- Homepage:
- Size: 32.2 KB
- Stars: 9
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Documentation Zero
The purpose of documentation zero is to generate a scaffold for rails api documentations using markdown.
## Example
You can see an example of the generated documentation [here](.api/README.md).
## Installation
Add this line to your application's Gemfile:
```ruby
gem "documentation-zero"
```
## Usage
```
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.
## Development
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](https://rubygems.org).
## Contributing
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](https://github.com/lazaronixon/documentation-zero/blob/master/CODE_OF_CONDUCT.md).
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in the DocumentationZero project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/lazaronixon/documentation-zero/blob/master/CODE_OF_CONDUCT.md).