{"id":20509600,"url":"https://github.com/aminnairi/markdown-summary","last_synced_at":"2026-04-30T02:35:52.520Z","repository":{"id":44585547,"uuid":"298178567","full_name":"aminnairi/markdown-summary","owner":"aminnairi","description":"Command line interface for creating summaries for your Markdown files.","archived":false,"fork":false,"pushed_at":"2022-02-07T07:37:34.000Z","size":44,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"development","last_synced_at":"2025-06-04T13:43:21.964Z","etag":null,"topics":["markdown","summary","title"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/@aminnairi/markdown-summary","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aminnairi.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-09-24T05:34:09.000Z","updated_at":"2022-02-06T20:53:54.000Z","dependencies_parsed_at":"2022-08-20T18:10:14.533Z","dependency_job_id":null,"html_url":"https://github.com/aminnairi/markdown-summary","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/aminnairi/markdown-summary","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aminnairi%2Fmarkdown-summary","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aminnairi%2Fmarkdown-summary/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aminnairi%2Fmarkdown-summary/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aminnairi%2Fmarkdown-summary/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aminnairi","download_url":"https://codeload.github.com/aminnairi/markdown-summary/tar.gz/refs/heads/development","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aminnairi%2Fmarkdown-summary/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260752072,"owners_count":23057287,"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":["markdown","summary","title"],"created_at":"2024-11-15T20:25:39.298Z","updated_at":"2026-04-30T02:35:47.496Z","avatar_url":"https://github.com/aminnairi.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# @aminnairi/markdown-summary\n\nCommand line interface for creating summaries for your Markdown files.\n\n[![npm](https://badgen.net/badge/npm/0.2.0/green)](https://www.npmjs.com/package/@aminnairi/markdown-summary/v/0.2.0) [![Tests](https://github.com/aminnairi/markdown-summary/actions/workflows/tests.yaml/badge.svg)](https://github.com/aminnairi/markdown-summary/actions/workflows/tests.yaml) [![vulnerabilities](https://badgen.net/snyk/aminnairi/markdown-summary@0.2.0)](https://snyk.io/) [![size](https://badgen.net/bundlephobia/minzip/@aminnairi/markdown-summary)](https://badgen.net/bundlephobia/minzip/@aminnairi/markdown-summary@0.2.0) [![Dependencies](https://badgen.net/bundlephobia/dependency-count/@aminnairi/markdown-summary@0.2.0)](https://badgen.net/bundlephobia/minzip/@aminnairi/markdown-summary@0.2.0)\n\n## Why\n\n- Prevent making mistakes when creating summaries\n- Great for large Markdown files\n- No installation required\n- Written in TypeScript\n\n## Summary\n\n- [@aminnairi/markdown-summary](#aminnairimarkdown-summary)\n  - [Why](#why)\n  - [Summary](#summary)\n  - [Usage](#usage)\n    - [Requirements](#requirements)\n    - [Usage](#usage-1)\n  - [Exit codes](#exit-codes)\n    - [Exit code 1](#exit-code-1)\n    - [Exit code 2](#exit-code-2)\n    - [Exit code 3](#exit-code-3)\n  - [Changelog](#changelog)\n  - [Code of conduct](#code-of-conduct)\n  - [Contributing](#contributing)\n  - [License](#license)\n\n## Usage\n\n[Summary](#summary)\n\n### Requirements\n\n- Node\n- NPX\n\n[Summary](#summary)\n\n### Usage\n\n```bash\nnpx @aminnairi/markdown-summary README.md\n- [@aminnairi/markdown-summary](#aminnairimarkdown-summary)\n  - [Summary](#summary)\n  - [Usage](#usage)\n    - [Requirements](#requirements)\n    - [Usage](#usage-1)\n  - [Exit codes](#exit-codes)\n    - [Exit code 1](#exit-code-1)\n    - [Exit code 2](#exit-code-2)\n    - [Exit code 3](#exit-code-3)\n```\n\n[Summary](#summary)\n\n## Exit codes\n\n[Summary](#summary)\n\n### Exit code 1\n\nWhenever the program is called without any file argument.\n\n[Summary](#summary)\n\n### Exit code 2\n\nWhenever the program is called with more than one file argument.\n\n[Summary](#summary)\n\n### Exit code 3\n\nWhenever an error happened when reading the file argument.\n\n[Summary](#summary)\n\n## Changelog\n\nSee [`CHANGELOG.md`](./CHANGELOG.md).\n\n## Code of conduct\n\nSee [`CODE_OF_CONDUCT.md`](./CODE_OF_CONDUCT.md).\n\n## Contributing\n\nSee [`CONTRIBUTING.md`](./CONTRIBUTING.md).\n\n## License\n\nSee [`LICENSE`](./LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faminnairi%2Fmarkdown-summary","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faminnairi%2Fmarkdown-summary","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faminnairi%2Fmarkdown-summary/lists"}