@aminnairi/markdown-summary
v0.2.0
Published
Command line interface for creating summaries for your Markdown files.
Downloads
5
Readme
@aminnairi/markdown-summary
Command line interface for creating summaries for your Markdown files.
Why
- Prevent making mistakes when creating summaries
- Great for large Markdown files
- No installation required
- Written in TypeScript
Summary
Usage
Requirements
- Node
- NPX
Usage
npx @aminnairi/markdown-summary README.md
- [@aminnairi/markdown-summary](#aminnairimarkdown-summary)
- [Summary](#summary)
- [Usage](#usage)
- [Requirements](#requirements)
- [Usage](#usage-1)
- [Exit codes](#exit-codes)
- [Exit code 1](#exit-code-1)
- [Exit code 2](#exit-code-2)
- [Exit code 3](#exit-code-3)
Exit codes
Exit code 1
Whenever the program is called without any file argument.
Exit code 2
Whenever the program is called with more than one file argument.
Exit code 3
Whenever an error happened when reading the file argument.
Changelog
See CHANGELOG.md
.
Code of conduct
See CODE_OF_CONDUCT.md
.
Contributing
See CONTRIBUTING.md
.
License
See LICENSE
.