# markdown-splitter

> split a markdown to multiple markdown files.

Latest version **1.0.5** (published 2016-05-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install markdown-splitter
pnpm add markdown-splitter
yarn add markdown-splitter
bun add markdown-splitter
```

Provides the command `markdown-splitter`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.5 |
| Published | 2016-05-15 |
| First published | 2015-10-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 7 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 6 |
| Author | azu |
| Maintainers | azu |
| Keywords | markdown, gitbook |

## Links

- npm: https://www.npmjs.com/package/markdown-splitter
- Repository: https://github.com/azu/markdown-splitter
- Issues: https://github.com/azu/markdown-splitter/issues
- npm.io page: https://npm.io/package/markdown-splitter

## Dependencies (7)

- [mkdirp](https://npm.io/package/mkdirp.md) ^0.5.1
- [remark](https://npm.io/package/remark.md) ^4.2.2
- [minimist](https://npm.io/package/minimist.md) ^1.2.0
- [exists-sync](https://npm.io/package/exists-sync.md) 0.0.3
- [concat-stream](https://npm.io/package/concat-stream.md) ^1.5.0
- [nlcst-to-string](https://npm.io/package/nlcst-to-string.md) ^1.0.0
- [string.prototype.repeat](https://npm.io/package/string.prototype.repeat.md) ^0.2.0

## Alternatives

- [@mdxeditor/editor](https://npm.io/package/@mdxeditor/editor.md) — 962.4K weekly downloads
- [mmdb-lib](https://npm.io/package/mmdb-lib.md) — 680.9K weekly downloads
- [playcanvas](https://npm.io/package/playcanvas.md) — 36.2K weekly downloads
- [@glw907/cairn-cms](https://npm.io/package/@glw907/cairn-cms.md) — 967 weekly downloads
- [markdown-to-confluence](https://npm.io/package/markdown-to-confluence.md) — 103 weekly downloads

## Recent versions

- 1.0.5 (latest) — 2016-05-15
- 1.0.4 — 2016-05-15
- 1.0.3 — 2015-10-16
- 1.0.2 — 2015-10-15
- 1.0.1 — 2015-10-15

## README

# markdown-splitter

Split markdown to multiple markdown files by `---`(HorizontalRule).

## Installation

    npm install markdown-splitter

## Usage

```sh
$ markdown-splitter all.md --output /path/to/dir [ --summary /path/to/SUMMARY.md ]
```

- `-o` `--output` : path to output directory
- `--summary` : path to SUMMARY.md([GitBook](https://github.com/GitbookIO/gitbook "GitBook"))

## Contributing

1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request :D

## License

MIT

---
_Source: https://npm.io/package/markdown-splitter · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._