https://github.com/aminnairi/markdown-summary

Command line interface for creating summaries for your Markdown files.
https://github.com/aminnairi/markdown-summary

markdown summary title

Last synced: about 2 months ago
JSON representation

Command line interface for creating summaries for your Markdown files.

• Host: GitHub
• URL: https://github.com/aminnairi/markdown-summary
• Owner: aminnairi
• License: gpl-3.0
• Created: 2020-09-24T05:34:09.000Z (over 4 years ago)
• Default Branch: development
• Last Pushed: 2022-02-07T07:37:34.000Z (about 3 years ago)
• Last Synced: 2025-02-16T14:09:19.081Z (2 months ago)
• Topics: markdown, summary, title
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/@aminnairi/markdown-summary
• Size: 43 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# @aminnairi/markdown-summary

Command line interface for creating summaries for your Markdown files.

[![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/[email protected])](https://snyk.io/) [![size](https://badgen.net/bundlephobia/minzip/@aminnairi/markdown-summary)](https://badgen.net/bundlephobia/minzip/@aminnairi/[email protected]) [![Dependencies](https://badgen.net/bundlephobia/dependency-count/@aminnairi/[email protected])](https://badgen.net/bundlephobia/minzip/@aminnairi/[email protected])

## Why

- Prevent making mistakes when creating summaries

- Great for large Markdown files

- No installation required

- Written in TypeScript

## Summary

- [@aminnairi/markdown-summary](#aminnairimarkdown-summary)

  - [Why](#why)

  - [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)

  - [Changelog](#changelog)

  - [Code of conduct](#code-of-conduct)

  - [Contributing](#contributing)

  - [License](#license)

## Usage

[Summary](#summary)

### Requirements

- Node

- NPX

[Summary](#summary)

### Usage

```bash

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)

```

[Summary](#summary)

## Exit codes

[Summary](#summary)

### Exit code 1

Whenever the program is called without any file argument.

[Summary](#summary)

### Exit code 2

Whenever the program is called with more than one file argument.

[Summary](#summary)

### Exit code 3

Whenever an error happened when reading the file argument.

[Summary](#summary)

## Changelog

See [`CHANGELOG.md`](./CHANGELOG.md).

## Code of conduct

See [`CODE_OF_CONDUCT.md`](./CODE_OF_CONDUCT.md).

## Contributing

See [`CONTRIBUTING.md`](./CONTRIBUTING.md).

## License

See [`LICENSE`](./LICENSE).