posthtml-markdownit

Transform markdown using markdown-it

[![Version][npm-version-shield]][npm] [![License][license-shield]][license] [![Build][travis-ci-shield]][travis-ci] [![Downloads][npm-stats-shield]][npm-stats]
## Introduction This plugin converts Markdown to HTML using [markdown-it](https://github.com/markdown-it/markdown-it). Before: ```html # Heading 1 --- Paragraph with some text *Italic* __Bold__ - List item 1 - List item 2 - List item 3 ``` After: ```html

Heading 1

Paragraph with some text

Italic Bold

``` ## Install ``` $ npm i -D posthtml-markdownit ``` ## Usage ```js const posthtml = require('posthtml') const markdown = require('posthtml-markdownit') posthtml([ markdown() ]) .process('# Test') .then(result => console.log(result.html)) //

Test

``` ### Importing files You can import and render Markdown files: Before: ```html # Imported ``` After: ```html

Imported

``` ## Syntax ### Tags Both `` and `` tags are suported. Before: ```html # Heading 1 ``` After: ```html

Heading 1

``` By default, the tags are removed. See the [tag attribute](#tag) if you need a wrapping tag around your Markdown content. ### Attributes You can also use `markdown` or `md` attributes on any element: Before: ```html
# Heading 1
``` After: ```html

Heading 1

``` #### `tag` You can use a `tag` attribute to wrap the resulting markup in a tag: Before: ```html # Heading 1 ``` After: ```html

Heading 1

``` ## Options ### `root` Type: `string`\ Default: `./` A path relative to which markdown files are [imported](#importing-files). ### `encoding` Type: `string`\ Default: `utf8` Encoding for imported Markdown files. ### `markdownit` Type: `object`\ Default: `{}` Options passed to markdown-it. See the [available options](https://github.com/markdown-it/markdown-it#init-with-presets-and-options). ### `plugins` Type: `array`\ Default: `[]` Plugins for markdown-it. Example: ```js markdown({ plugins: [{ plugin: require('markdown-it-emoji'), options: {} // Options for markdown-it-emoji }] }) ``` [npm]: https://www.npmjs.com/package/posthtml-markdownit [npm-version-shield]: https://img.shields.io/npm/v/posthtml-markdownit.svg [npm-stats]: http://npm-stat.com/charts.html?package=posthtml-markdownit [npm-stats-shield]: https://img.shields.io/npm/dt/posthtml-markdownit.svg [travis-ci]: https://travis-ci.org/posthtml/posthtml-markdownit/ [travis-ci-shield]: https://img.shields.io/travis/posthtml/posthtml-markdownit/master.svg [license]: ./LICENSE [license-shield]: https://img.shields.io/npm/l/posthtml-markdownit.svg