{"id":15792876,"url":"https://github.com/lazaronixon/documentation-zero","last_synced_at":"2025-09-11T18:32:00.606Z","repository":{"id":62557355,"uuid":"471255706","full_name":"lazaronixon/documentation-zero","owner":"lazaronixon","description":"A rest api documentation generator for rails applications using markdown","archived":false,"fork":false,"pushed_at":"2022-04-26T11:59:27.000Z","size":33,"stargazers_count":9,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-04-26T13:20:39.578Z","etag":null,"topics":["api-rest","documentation","generator","rails","rest"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lazaronixon.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-03-18T06:12:46.000Z","updated_at":"2024-01-09T21:22:24.000Z","dependencies_parsed_at":"2022-11-03T06:15:43.969Z","dependency_job_id":null,"html_url":"https://github.com/lazaronixon/documentation-zero","commit_stats":null,"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lazaronixon%2Fdocumentation-zero","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lazaronixon%2Fdocumentation-zero/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lazaronixon%2Fdocumentation-zero/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lazaronixon%2Fdocumentation-zero/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lazaronixon","download_url":"https://codeload.github.com/lazaronixon/documentation-zero/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":232659180,"owners_count":18557021,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api-rest","documentation","generator","rails","rest"],"created_at":"2024-10-04T23:06:19.373Z","updated_at":"2025-01-06T00:41:27.214Z","avatar_url":"https://github.com/lazaronixon.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Documentation Zero\n\nThe purpose of documentation zero is to generate a scaffold for rails api documentations using markdown.\n\n## Example\n\nYou can see an example of the generated documentation [here](.api/README.md).\n\n## Installation\n\nAdd this line to your application's Gemfile:\n\n```ruby\ngem \"documentation-zero\"\n```\n\n## Usage\n\n```\nrails generate documentation:readme\n```\n\n```\nrails generate documentation:scaffold posts title:string body:text published:boolean user:references\n```\n\nAdd `- [Posts](sections/posts.md)` to API endpoints section.\n\n## Development\n\nTo 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).\n\n## Contributing\n\nBug 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).\n\n## License\n\nThe gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).\n\n## Code of Conduct\n\nEveryone 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).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flazaronixon%2Fdocumentation-zero","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flazaronixon%2Fdocumentation-zero","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flazaronixon%2Fdocumentation-zero/lists"}