{"id":29945812,"url":"https://github.com/magloft/grape-docs","last_synced_at":"2025-10-05T23:52:37.839Z","repository":{"id":56875126,"uuid":"118553152","full_name":"magloft/grape-docs","owner":"magloft","description":"grape-docs automagically generates documentation for your Grape API in various formats.","archived":false,"fork":false,"pushed_at":"2018-05-11T04:06:43.000Z","size":14,"stargazers_count":4,"open_issues_count":1,"forks_count":2,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-10-01T12:44:52.812Z","etag":null,"topics":["documentation","grape","grape-api","grape-swagger","markdown"],"latest_commit_sha":null,"homepage":null,"language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/magloft.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-01-23T03:36:35.000Z","updated_at":"2022-03-27T06:50:15.000Z","dependencies_parsed_at":"2022-08-20T10:40:34.822Z","dependency_job_id":null,"html_url":"https://github.com/magloft/grape-docs","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/magloft/grape-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/magloft%2Fgrape-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/magloft%2Fgrape-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/magloft%2Fgrape-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/magloft%2Fgrape-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/magloft","download_url":"https://codeload.github.com/magloft/grape-docs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/magloft%2Fgrape-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278537752,"owners_count":26003249,"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","status":"online","status_checked_at":"2025-10-05T02:00:06.059Z","response_time":54,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["documentation","grape","grape-api","grape-swagger","markdown"],"created_at":"2025-08-03T05:02:09.056Z","updated_at":"2025-10-05T23:52:37.813Z","avatar_url":"https://github.com/magloft.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# grape-docs\n\n\u003e Automatically generate markdown documentation from your grape API\n\n## Description\n\ngrape-docs automagically generates documentation for your Grape API in various formats.\n\nThe Gem will automatically analyze your Grape API structure, mounts, namespaces and routes, and will build a markdown documentation in separate files.\n\nIt's best used combined with [GitBook](https://www.gitbook.com) and [gitbook-plugin-api](https://github.com/MagLoft/gitbook-plugin-api) to transform your markdown documentation into a good-looking and browsable API navigation.\n\n## Installation\n\nInstall globally using `gem install grape-docs` or include it in your project Gemfile:\n\n```ruby\nsource 'http://rubygems.org'\n\ngem 'grape-docs'\n```\n\n## Usage\n\nRun the `grape-docs export` command to export your documentation from within your Grape API project directory:\n\n```\nUsage:\n  grape-docs export \u003capi_name\u003e \u003cexport_path\u003e\n\nArguments:\n  \u003capi_name\u003e                 # Constant name of your Grape API, e.g. MyApp::Api\n  \u003cexport_path\u003e              # Directory / path where the markdown documentation will be generated in\n\nOptions:\n  -h, [--host=HOST]          # API Host\n                             # Default: https://api.example.com/\n  -t, [--template=TEMPLATE]  # Markdown template (default, gitbook) or custom (requires .md.erb extension)\n                             # Default: default\n  -r, [--require=REQUIRE]    # Ruby environment require path\n                             # Default: config/environment.rb\n\nExport documentation of API named \u003capi_name\u003e to \u003cexport_path\u003e directory\n```\n\n## Result\n\n| Template `default`                                                       | Template `gitbook`                                                       |\n| :----------------------------------------------------------------------: | :----------------------------------------------------------------------: |\n| ![default](http://cdn.magloft.com/marketing/gems/grape-docs/default.png) | ![gitbook](http://cdn.magloft.com/marketing/gems/grape-docs/gitbook.png) |\n\n## License\n\ngrape-docs is available under an MIT-style license.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmagloft%2Fgrape-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmagloft%2Fgrape-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmagloft%2Fgrape-docs/lists"}