{"id":15474930,"url":"https://github.com/linuxbozo/yours-truly","last_synced_at":"2026-06-21T01:31:45.563Z","repository":{"id":11265139,"uuid":"13668851","full_name":"LinuxBozo/yours-truly","owner":"LinuxBozo","description":null,"archived":false,"fork":false,"pushed_at":"2021-02-12T21:25:16.000Z","size":12,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-07-06T19:25:59.948Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"HTML","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/LinuxBozo.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-10-18T04:17:34.000Z","updated_at":"2017-05-05T03:13:10.000Z","dependencies_parsed_at":"2022-09-19T09:10:47.257Z","dependency_job_id":null,"html_url":"https://github.com/LinuxBozo/yours-truly","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/LinuxBozo/yours-truly","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LinuxBozo%2Fyours-truly","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LinuxBozo%2Fyours-truly/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LinuxBozo%2Fyours-truly/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LinuxBozo%2Fyours-truly/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/LinuxBozo","download_url":"https://codeload.github.com/LinuxBozo/yours-truly/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LinuxBozo%2Fyours-truly/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265878829,"owners_count":23843024,"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":[],"created_at":"2024-10-02T03:05:49.190Z","updated_at":"2026-06-21T01:31:45.525Z","avatar_url":"https://github.com/LinuxBozo.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# yours-truly\n\nThis is a node.js [API Blueprint](http://apiblueprint.org/) formatter for producing HTML documents.\n\nIt uses [protagonist](https://npmjs.org/package/protagonist) and [ejs](https://npmjs.org/package/ejs) to do all the dirty work.\n\n## Writing API documentation\n\nFor more info on writing API documentation, read up on the API Blueprint [specification](https://github.com/apiaryio/api-blueprint/blob/master/API%20Blueprint%20Specification.md).\n\nHere's a small sample:\n\n\n    FORMAT: 1A\n    HOST: https://api.example.com/v1\n\n    # Example API\n\n    A simple API example\n\n    # Group People\n\n    This section describes the People endpoint\n\n    ## Person [/people/{id}]\n\n    Represent a particular Person\n\n    + Parameters\n\n        + id (required, string, `123`) ... The id of the Person.\n\n    + Model (application/json)\n\n        ```\n        {\"first_name\":\"Samuel\",\"last_name\":\"Adams\",\"birthdate\":\"09-27-1722\"}\n        ```\n\n    ### Retrieve Person [GET]\n\n    Return the information for the Person\n\n    + Response 200 (application/json)\n\n        [Person][]\n\n\n\n## Usage: CLI\n\n    $ ./node_modules/yours-truly/bin/yours-truly INPUT_FILE.md [OUTPUT_FILE.html]\n\n### Examples\n\n#### Output to stdout\n\n1. Create your API markdown file, e.g. `blueprint.md`\n1. Run `./node_modules/yours-truly/bin/yours-truly blueprint.md`\n1. Pipe the output somewhere\n1. Done!\n\n#### Output to HTML file\n\n1. Create your API markdown file, e.g. `blueprint.md`\n1. Run `./node_modules/yours-truly/bin/yours-truly blueprint.md blueprint.html`\n1. Done!\n\n##### Notes\n\n- Trying to view the output HTML file in your browser directly from the filesystem will not display correctly.\n\n## Usage: node module\n\n```js\nvar yt = require('yours-truly'),\n    html = yt('/path/to/blueprint.md');\n```\n\n## Related Projects\n\nIf the GO language is more your thing, you might want to check out these projects\n\n- [github.com/subosita/iglo](https://github.com/subosito/iglo) : Original inspiration of this project\n\n- [github.com/peterhellberg/hiro](https://github.com/peterhellberg/hiro) : Uses iglo to output HTML to a file\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flinuxbozo%2Fyours-truly","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flinuxbozo%2Fyours-truly","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flinuxbozo%2Fyours-truly/lists"}