https://github.com/ulivz/markdown-catalogue-parser

markdown catalogue parser
https://github.com/ulivz/markdown-catalogue-parser

Last synced: 7 months ago
JSON representation

markdown catalogue parser

• Host: GitHub
• URL: https://github.com/ulivz/markdown-catalogue-parser
• Owner: ulivz
• License: mit
• Created: 2017-12-17T05:58:30.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2019-07-30T16:51:26.000Z (about 6 years ago)
• Last Synced: 2025-03-02T17:06:13.522Z (8 months ago)
• Language: TypeScript
• Homepage: http://www.v2js.com/markdown-catalogue-parser/
• Size: 168 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# markdown-catalogue-parser

[![NPM version](https://img.shields.io/npm/v/markdown-catalogue-parser.svg?style=flat)](https://npmjs.com/package/markdown-catalogue-parser) [![NPM downloads](https://img.shields.io/npm/dm/markdown-catalogue-parser.svg?style=flat)](https://npmjs.com/package/markdown-catalogue-parser) [![CircleCI](https://circleci.com/gh/ULIVZ/markdown-catalogue-parser/tree/master.svg?style=shield)](https://circleci.com/gh/ULIVZ/markdown-catalogue-parser/tree/master)  [![codecov](https://codecov.io/gh/ULIVZ/markdown-catalogue-parser/branch/master/graph/badge.svg)](https://codecov.io/gh/ULIVZ/markdown-catalogue-parser)

 [![donate](https://img.shields.io/badge/$-donate-ff69b4.svg?maxAge=2592000&style=flat)](https://github.com/ULIVZ/donate)

## Install

```bash

npm i markdown-catalogue-parser

```

## Usage

```js

const markdownCatalogueParser = require('markdown-catalogue-parser')

const catalogue = markdownCatalogueParser('README.md')

```

then `catalogue` will be as follows:

```markdown

- [markdown-catalogue-parser](#markdown-catalogue-parser)

  * [Install](#install)

  * [Usage](#usage)

  * [Contributing](#contributing)

  * [Author](#author)

```

## 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

## Author

**markdown-catalogue-parser** © [ulivz](https://github.com/ULIVZ), Released under the [MIT](./LICENSE) License.


Authored and maintained by ulivz with help from contributors ([list](https://github.com/ULIVZ/markdown-catalogue-parser/contributors)).

> [github.com/ulivz](https://github.com/ulivz) · GitHub [@ulivz](https://github.com/ULIVZ)