posthtml-md2html
v0.0.2
Published
PostHTML plugin render markdown inside html elements.
Downloads
14
Maintainers
Readme
posthtml-md2html
[posthtml-md2html] is a markdown plugin for [PostHTML] that lets you use markdown within HTML elements in an easy and intuitive way.
Main features:
- Works on any tag with a
md
ormarkdown
property - Knows when to write inline or block-level content
- Will replace element if tag is
<md>
or<markdown>
- Will treat
pre
tag withmd
ormarkdown
property as<md>
tag
Before:
<markdown># Heading with *italics*</markdown>
<markdown>**Bold** paragraph</markdown>
<div markdown>
| Head | row |
|------|-----|
| Data | row |
</div>
<main markdown>
> # Title
>
> This is blockquote paragraph
</main>
After:
<h1 id="heading-with-italics">Heading with <em>italics</em></h1>
<p><strong>Bold</strong> paragraph</p>
<div><table>
<thead>
<tr>
<th>Head</th>
<th>row</th>
</tr>
</thead>
<tbody><tr>
<td>Data</td>
<td>row</td>
</tr>
</tbody></table>
</div>
<main><blockquote>
<h1 id="title">Title</h1>
<p>This is blockquote paragraph</p>
</blockquote>
</main>
Install
npm i -S posthtml posthtml-md2html
Note: This project is compatible with node v10+
Usage
const fs = require('fs');
const posthtml = require('posthtml');
const posthtmlPlugin = require('posthtml-md2html');
posthtml()
.use(posthtmlPlugin({ /* options */ }))
.process(html/*, options */)
.then(result => fs.writeFileSync('./after.html', result.html));
Options
All options are passed to marked directly
Contributing
See PostHTML Guidelines and contribution guide.