Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

posthtml-md2html

0.0.2 • Public • Published

posthtml-md2html

NPM Deps Build Coverage Standard Code Style Chat

[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 or markdown property
  • Knows when to write inline or block-level content
  • Will replace element if tag is <md> or <markdown>
  • Will treat pre tag with md or markdown 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.

Install

npm i posthtml-md2html

DownloadsWeekly Downloads

1

Version

0.0.2

License

MIT

Unpacked Size

15.1 kB

Total Files

28

Last publish

Collaborators

  • avatar