# jekyll-markdown-parser

> A Jekyll Markdown parser using TypeScript

Latest version **4.0.0** (published 2020-01-25) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install jekyll-markdown-parser
pnpm add jekyll-markdown-parser
yarn add jekyll-markdown-parser
bun add jekyll-markdown-parser
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 4.0.0 |
| Published | 2020-01-25 |
| First published | 2016-07-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 8.8 KB |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 3 |
| Author | bouzuya |
| Maintainers | bouzuya |

## Links

- npm: https://www.npmjs.com/package/jekyll-markdown-parser
- Repository: https://github.com/bouzuya/jekyll-markdown-parser
- Homepage: https://github.com/bouzuya/jekyll-markdown-parser#readme
- Issues: https://github.com/bouzuya/jekyll-markdown-parser/issues
- npm.io page: https://npm.io/package/jekyll-markdown-parser

## Dependencies (2)

- [marked](https://npm.io/package/marked.md) ^0.8.0
- [js-yaml](https://npm.io/package/js-yaml.md) ^3.13.1

## Recent versions

- 4.0.0 (latest) — 2020-01-25
- 3.0.0 — 2019-12-28
- 2.0.0 — 2019-04-15
- 1.1.1 — 2018-01-07
- 1.1.0 — 2017-10-13
- 1.0.1 — 2017-08-27
- 1.0.0 — 2016-10-09
- 0.1.3 — 2016-09-10
- 0.1.2 — 2016-07-30
- 0.1.1 — 2016-07-30
- 0.1.0 — 2016-07-30

## README

# jekyll-markdown-parser

A [Jekyll](https://jekyllrb.com/) Markdown parser using TypeScript.

## Installation

```
$ npm install jekyll-markdown-parser
```

## Usage

```ts
import * as assert from 'assert';
import { parse } from 'jekyll-markdown-parser';

const jekyllMarkdown = [
  '---',
  'layout: post',
  'title: Hello Jekyll',
  '---',
  'This is my first entry.'
].join('\n');
assert.deepEqual(
  parse(jekyllMarkdown),
  {
    html: '<p>This is my first entry.</p>\n',
    markdown: 'This is my first entry.',
    parsedYaml: {
      layout: 'post',
      title: 'Hello Jekyll'
    },
    yaml: 'layout: post\ntitle: Hello Jekyll\n'
  }
);
```

or use `compileMarkdown` / `parseYaml` / `separate`. See [`test/index.ts`](test/index.ts).

## Badges

[![npm version][npm-badge-url]][npm-url]
[![Travis CI][travisci-badge-url]][travisci-url]

[npm-badge-url]: https://img.shields.io/npm/v/jekyll-markdown-parser.svg
[npm-url]: https://www.npmjs.com/package/jekyll-markdown-parser
[travisci-badge-url]: https://img.shields.io/travis/bouzuya/jekyll-markdown-parser.svg
[travisci-url]: https://travis-ci.org/bouzuya/jekyll-markdown-parser

## License

[MIT](LICENSE)

## Author

[bouzuya][user] &lt;[m@bouzuya.net][email]&gt; ([http://bouzuya.net][url])

[user]: https://github.com/bouzuya
[email]: mailto:m@bouzuya.net
[url]: http://bouzuya.net

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