{"id":20279235,"url":"https://github.com/peterhellberg/hiro","last_synced_at":"2025-04-11T06:18:19.819Z","repository":{"id":11204554,"uuid":"13589046","full_name":"peterhellberg/hiro","owner":"peterhellberg","description":"Generates HTML from API Blueprints using the Snow Crash command line tool Drafter and Iglo.","archived":false,"fork":false,"pushed_at":"2021-08-25T13:23:55.000Z","size":35,"stargazers_count":54,"open_issues_count":0,"forks_count":4,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-11T06:18:15.366Z","etag":null,"topics":["api-blueprint","drafter","go","snow-crash"],"latest_commit_sha":null,"homepage":"","language":"Go","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/peterhellberg.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":"2013-10-15T12:11:52.000Z","updated_at":"2023-10-22T15:30:32.000Z","dependencies_parsed_at":"2022-09-11T16:10:31.556Z","dependency_job_id":null,"html_url":"https://github.com/peterhellberg/hiro","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peterhellberg%2Fhiro","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peterhellberg%2Fhiro/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peterhellberg%2Fhiro/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peterhellberg%2Fhiro/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/peterhellberg","download_url":"https://codeload.github.com/peterhellberg/hiro/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248351429,"owners_count":21089282,"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-blueprint","drafter","go","snow-crash"],"created_at":"2024-11-14T13:29:02.037Z","updated_at":"2025-04-11T06:18:19.790Z","avatar_url":"https://github.com/peterhellberg.png","language":"Go","readme":"Hiro\n====\n\nGenerates HTML from API Blueprints using the [Snow Crash](https://github.com/apiaryio/snowcrash) command line tool\n[Drafter](https://github.com/apiaryio/drafter) and [Iglo](https://github.com/subosito/iglo).\n\n[![GoDoc](https://godoc.org/github.com/peterhellberg/hiro/hiro?status.svg)](https://godoc.org/github.com/peterhellberg/hiro/hiro)\n[![License MIT](https://img.shields.io/badge/license-MIT-lightgrey.svg?style=flat)](https://github.com/peterhellberg/hiro#license-mit)\n\n## Dependencies\n\nHiro requires [Drafter](https://github.com/apiaryio/drafter) *v3.x* to be installed.\n\nAny newer release is not supported due to usage of the deprecated `--type=ast`\noption ([apiaryio/drafter@a7dd4c5](https://github.com/apiaryio/drafter/commit/a7dd4c5)).\n\nInstall it on OS X using Homebrew:\n\n```bash\n$ brew install --HEAD \\\n  https://raw.githubusercontent.com/apiaryio/drafter/stable/3.x/tools/homebrew/drafter.rb\n```\n\nRefer to the Drafter [build](https://github.com/apiaryio/drafter#build) notes if you are using a different OS.\n\n## Installation\n\n```bash\n$ go get -u github.com/peterhellberg/hiro\n```\n\nYou can also download binaries from the [releases page](https://github.com/peterhellberg/hiro/releases).\n\n## Usage\n\n```bash\n$ hiro --help\n\nCommand line arguments:\n\n  -input=\"blueprint.md\": Input file (.md)\n  -output=\"index.html\": Output file (.html)\n  -template=\"\": Iglo template file\n```\n\n## Example\n\n```markdown\n# Service Name\n\nA short description of the service.\n\n## Group Group 1\n\nA description of this group of endpoints\n\n## /endpoint\n\n+ Parameters\n  + foo (required, string, `example`)\n  A description of the foo parameter\n  + bar (optional, integer, `123`)\n  A description of the bar parameter\n\n### GET\n\nA description of the endpoint.\n\nheader | another header\n-------|---------------\nfoo    | bar\nbaz    | qux\n\n\u003e A quote related to the endpoint\n\n**Bold text**\n\n    func some(code Example) string {\n      return \"related to the endpoint\"\n    }\n\n+ Response 200 (application/json; charset=utf-8)\n  + Headers\n  X-Example header\n  + Body\n  {\"endpoint\": \"response\"}\n\n## Group Group 2\n\nA description of this group of endpoints.\n```\n\n![Hiro Blueprint Output](https://assets.c7.se/skitch/Hiro_Blueprint_Output_Example-20160511-161557.png)\n\n## License (MIT)\n\nCopyright (c) 2015-2016 [Peter Hellberg](http://c7.se/)\n\n\u003e Permission is hereby granted, free of charge, to any person obtaining\n\u003e a copy of this software and associated documentation files (the\n\u003e \"Software\"), to deal in the Software without restriction, including\n\u003e without limitation the rights to use, copy, modify, merge, publish,\n\u003e distribute, sublicense, and/or sell copies of the Software, and to\n\u003e permit persons to whom the Software is furnished to do so, subject to\n\u003e the following conditions:\n\n\u003e The above copyright notice and this permission notice shall be\n\u003e included in all copies or substantial portions of the Software.\n\n\u003e THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND,\n\u003e EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\n\u003e MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND\n\u003e NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE\n\u003e LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION\n\u003e OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION\n\u003e WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpeterhellberg%2Fhiro","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpeterhellberg%2Fhiro","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpeterhellberg%2Fhiro/lists"}