{"id":15789556,"url":"https://github.com/transitive-bullshit/update-markdown-usage","last_synced_at":"2025-04-01T13:33:49.977Z","repository":{"id":44127883,"uuid":"133267991","full_name":"transitive-bullshit/update-markdown-usage","owner":"transitive-bullshit","description":"Updates a markdown section with CLI usage info via --help.","archived":false,"fork":false,"pushed_at":"2023-01-04T00:48:28.000Z","size":933,"stargazers_count":4,"open_issues_count":9,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-10-20T01:09:53.782Z","etag":null,"topics":["cli","markdown","usage"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/transitive-bullshit.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-05-13T19:31:27.000Z","updated_at":"2023-03-16T00:30:38.000Z","dependencies_parsed_at":"2023-02-01T16:01:40.643Z","dependency_job_id":null,"html_url":"https://github.com/transitive-bullshit/update-markdown-usage","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/transitive-bullshit%2Fupdate-markdown-usage","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/transitive-bullshit%2Fupdate-markdown-usage/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/transitive-bullshit%2Fupdate-markdown-usage/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/transitive-bullshit%2Fupdate-markdown-usage/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/transitive-bullshit","download_url":"https://codeload.github.com/transitive-bullshit/update-markdown-usage/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":222650450,"owners_count":17017274,"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":["cli","markdown","usage"],"created_at":"2024-10-04T22:02:15.881Z","updated_at":"2024-11-02T15:06:37.425Z","avatar_url":"https://github.com/transitive-bullshit.png","language":"JavaScript","readme":"# update-markdown-usage\n\n\u003e Updates a markdown document section with CLI usage info via `--help`.\n\n[![NPM](https://img.shields.io/npm/v/update-markdown-usage.svg)](https://www.npmjs.com/package/update-markdown-usage) [![Build Status](https://travis-ci.com/transitive-bullshit/update-markdown-usage.svg?branch=master)](https://travis-ci.com/transitive-bullshit/update-markdown-usage) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)\n\nThis module makes it easy for a node CLI module to update the usage section of its readme by pasting in the results of running with `--help`.\n\nSee the `docs` script in this module's [package.json](package.json) for a concrete example of how this readme's `Usage` section is updated automatically.\n\n## Install\n\n```bash\nnpm install -g update-markdown-usage\n```\n\n## Usage\n\n```bash\n  Usage: update-markdown-usage [options]\n\n  Options:\n\n    -V, --version           output the version number\n    -f, --file \u003cfilename\u003e   markdown file to update (defaults to local readme)\n    -i, --stdin             read usage from stdin (defaults to running pkg binary with --help)\n    -P, --prefix \u003cstring\u003e   optional markdown section prefix\n    -S, --suffix \u003cstring\u003e   optional markdown section suffix\n    -s, --section \u003cstring\u003e  name of markdown section to update (default: usage)\n    -W, --no-write          write result to stdout (defaults to updating markdown file)\n    -h, --help              output usage information\n```\n\n## NPM scripts\n\n```json\n  \"scripts: {\n    \"docs\": \"update-markdown-usage\"\n  },\n```\n\n## Related\n\n- [update-markdown-jsdoc](https://github.com/transitive-bullshit/update-markdown-jsdoc) - Same as this module but for documenting libraries with jsdoc.\n- [mdast-util-inject](https://github.com/anandthakker/mdast-util-inject) - Mdast utility to inject some markdown content into some other markdown at a certain heading.\n- [add-text-to-markdown](https://github.com/azu/add-text-to-markdown) - Add stdin text to exist markdown file.\n\n## License\n\nMIT © [Travis Fischer](https://transitivebullsh.it)\n\nSupport my OSS work by \u003ca href=\"https://twitter.com/transitive_bs\"\u003efollowing me on twitter \u003cimg src=\"https://storage.googleapis.com/saasify-assets/twitter-logo.svg\" alt=\"twitter\" height=\"24px\" align=\"center\"\u003e\u003c/a\u003e\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftransitive-bullshit%2Fupdate-markdown-usage","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftransitive-bullshit%2Fupdate-markdown-usage","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftransitive-bullshit%2Fupdate-markdown-usage/lists"}