13.0.0 • Published 3 years ago

markup-it v13.0.0

Weekly downloads
378
License
Apache-2.0
Repository
github
Last release
3 years ago

markup-it

Build Status NPM version

markup-it is a JavaScript library to serialize/deserialize markdown content using an intermediate format backed by an immutable model.

Installation

$ npm i markup-it --save

or

$ yarn add markup-it

Usage

Parse markdown

const { State, MarkdownParser } = require('markup-it');

const state = State.create(MarkdownParser);
const document = state.deserializeToDocument('Hello **World**');

Render document to HTML

const { State, HTMLParser } = require('markup-it');

const state = State.create(HTMLParser);
const str = state.serializeDocument(document);

Render document to Markdown

const { State, MarkdownParser } = require('markup-it');

const state = State.create(markdown);
const str = state.serializeDocument(document);

ES6

markup-it is ESM compliant through the package.json module field, so you can safely use it with ES6 syntax for tree-shaking.

import { State, HTMLParser } from 'markup-it';

const state = State.create(HTMLParser);
const str = state.serializeDocument(document);

Testing

There are many scripts available in the /bin folder to output an HTML or Markdown file to multiple formats (HTML, Hyperscript, JSON, Markdown, YAML).

These scripts can be called with babel-node, for example:

babel-node bin/toJSON.js ./page.md
13.0.0

3 years ago

12.1.1

4 years ago

12.1.0

4 years ago

12.0.5

4 years ago

12.0.4

4 years ago

12.0.3

4 years ago

12.0.2

4 years ago

12.0.1

4 years ago

12.0.0

4 years ago

11.1.8

5 years ago

11.1.7

5 years ago

11.1.6

5 years ago

11.1.5

5 years ago

11.1.4

5 years ago

11.1.3

5 years ago

11.1.2

5 years ago

11.1.1

5 years ago

11.1.0

5 years ago

11.0.0

6 years ago

10.0.0

6 years ago

9.0.0

6 years ago

8.1.3

6 years ago

8.1.3-alpha.0

6 years ago

8.1.2

6 years ago

8.1.1

6 years ago

8.1.0

6 years ago

8.0.3

6 years ago

8.0.2

6 years ago

8.0.1

6 years ago

8.0.0

6 years ago

7.0.4

6 years ago

7.0.3

6 years ago

6.0.6

6 years ago

7.0.2

6 years ago

6.0.5

6 years ago

6.0.4

6 years ago

6.0.3

6 years ago

6.0.2

6 years ago

7.0.1

6 years ago

6.0.1

6 years ago

7.0.0

6 years ago

6.0.0

6 years ago

6.0.0-pre.1

6 years ago

6.0.0-pre.0

6 years ago

5.1.2

6 years ago

5.1.1

6 years ago

5.1.0

6 years ago

5.0.2

6 years ago

5.0.1

6 years ago

5.0.0

6 years ago

4.0.2

6 years ago

4.0.1

6 years ago

4.0.0

7 years ago

3.6.0

7 years ago

3.5.2

7 years ago

3.5.1

7 years ago

3.5.0

7 years ago

3.4.2

7 years ago

3.4.1

7 years ago

3.4.0

7 years ago

3.3.7

7 years ago

3.3.6

7 years ago

4.0.0-pre.1

7 years ago

3.3.5

7 years ago

3.3.4

7 years ago

4.0.0-pre.0

7 years ago

3.3.3

7 years ago

3.3.2

7 years ago

3.3.1

7 years ago

3.3.0

7 years ago

3.2.0

7 years ago

3.1.2

7 years ago

3.1.1

7 years ago

3.1.0

7 years ago

3.0.2

7 years ago

3.0.1

7 years ago

3.0.0

7 years ago

3.0.0-pre.6

7 years ago

3.0.0-pre.5

7 years ago

3.0.0-pre.4

7 years ago

3.0.0-pre.3

7 years ago

3.0.0-pre.2

7 years ago

3.0.0-pre.1

7 years ago

2.5.0

8 years ago

2.4.0

8 years ago

2.3.0

8 years ago

2.2.0

8 years ago

2.1.2

8 years ago

2.1.1

8 years ago

2.1.0

8 years ago

2.0.1

8 years ago

2.0.0

8 years ago

1.0.0

8 years ago

1.0.0-pre.0

8 years ago