{"id":15601142,"url":"https://github.com/yinyanfr/args-md","last_synced_at":"2025-10-25T21:02:45.076Z","repository":{"id":154481942,"uuid":"631655913","full_name":"yinyanfr/args-md","owner":"yinyanfr","description":"The CLI tool that output the help message of args as markdown.","archived":false,"fork":false,"pushed_at":"2023-04-24T14:03:59.000Z","size":73,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-03T11:14:51.504Z","etag":null,"topics":["args","cli","documentation","documentation-generator","documentation-tool","markdown"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/args-md","language":"TypeScript","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/yinyanfr.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-04-23T17:52:35.000Z","updated_at":"2023-04-24T14:35:04.000Z","dependencies_parsed_at":null,"dependency_job_id":"a1d08ab4-97fe-498c-b0df-41776a7f2fc3","html_url":"https://github.com/yinyanfr/args-md","commit_stats":{"total_commits":4,"total_committers":1,"mean_commits":4.0,"dds":0.0,"last_synced_commit":"fccddc05f710c4fb149436c2b088a166b10d8977"},"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yinyanfr%2Fargs-md","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yinyanfr%2Fargs-md/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yinyanfr%2Fargs-md/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yinyanfr%2Fargs-md/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yinyanfr","download_url":"https://codeload.github.com/yinyanfr/args-md/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246122392,"owners_count":20726823,"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":["args","cli","documentation","documentation-generator","documentation-tool","markdown"],"created_at":"2024-10-03T02:15:37.669Z","updated_at":"2025-10-25T21:02:45.007Z","avatar_url":"https://github.com/yinyanfr.png","language":"TypeScript","readme":"# args-md\n\n[![npm](https://img.shields.io/npm/v/args-md.svg?style=flat-square)](https://www.npmjs.com/package/args-md)\n[![license](https://img.shields.io/npm/l/args-md.svg?style=flat-square)](https://github.com/yinyanfr/args-md/blob/main/LICENSE)\n![size](https://img.shields.io/github/repo-size/yinyanfr/args-md?style=flat-square)\n[![GitHub release](https://img.shields.io/github/release/yinyanfr/args-md.svg?style=flat-square)](https://github.com/yinyanfr/args-md/releases/latest)\n\nEnglish | [简体中文](https://github.com/yinyanfr/args-md/blob/main/README.zh-Hans.md)\n\nThe CLI tool that output the help message of [args](https://www.npmjs.com/package/args) as markdown.\n\n## :green_book: Quick Start\n\n### :wrench: CLI\n\n```bash\nyour_cli help | npx args-md \u003e cli.md\n```\n\n[Demo](https://github.com/yinyanfr/args-md/blob/main/src/tests/seeds/help.md)\n\n### :book: Library\n\n```typescript\nimport { parseHelp, formatHelp } from 'args-md';\n\n// the array of string of the help text grouped by line\nconst contents: string[] = [];\n\nconst help = parseHelp(contents);\n\nconst md = formatHelp(contents);\n```\n\nYou can find the type definitions of `help` in [`src/global.d.ts`](https://github.com/yinyanfr/args-md/blob/main/src/global.d.ts).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyinyanfr%2Fargs-md","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyinyanfr%2Fargs-md","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyinyanfr%2Fargs-md/lists"}