A Metalsmith plugin to use markdown content within html tags via data-markdown attribute
JavaScript
Permalink
Failed to load latest commit information.
spec
.gitignore initial Oct 2, 2014
README.md
index.js add tests and fix ugly default setup code Oct 29, 2014
package.json

README.md

metalsmith-data-markdown

A Metalsmith plugin to use markdown content within html tags via data-markdown attribute

Parses markdown (via marked) and inserts generated html in all tags that have the data-markdown attribute set (via cheerio).

Based on idea and code by Paul Irish. His implementation is currently used in reveal.js, a presentation framework. Likewise, this metalsmith plugin might become handy, if you want to compile these presentations down to HTML(during generation time with metalsmith.
Extracted from majodev.github.io.

As part the my note "Extracting libs from a node.js project: Publishing my metalsmith plugins".

Installation

npm install --save metalsmith-data-markdown

Usage

var Metalsmith = require("metalsmith");
var datamarkdown = require("metalsmith-data-markdown");

Metalsmith(__dirname)
  // ... state when html files are available
  .use(datamarkdown())
  // ...

Should also work in similar fashion with the metalsmith.json counterpart.

Options

datamarkdown accepts an hash to provide a few customization options.

marked (optional)

Object: Options you want to hand over to marked. Will get invoked via marked.setOptions(options.marked);. default: undefined

removeAttributeAfterwards (optional)

Boolean: If data-markdown attributes should be removed from tags after they were processed. default: false

Full example with options set

Here's how this will work with some marked options set + full input and output.

metalsmith config

var Metalsmith = require("metalsmith");
var headingsidentifier = require("metalsmith-headingsidentifier");


Metalsmith(__dirname)
  // ... state when html files are available
  .use(datamarkdown({
    marked: {
      gfm: true,
      breaks: true,
      tables: true,
      smartLists: true,
      smartypants: true
    },
    removeAttributeAfterwards: true
  }))
  // ...

html example input

<!-- ... -->
<section>
<section id="paper-esecurity-cover" data-markdown>
### WLAN Security Revisited (paper)
#### Rogue AP, Deauthentication Attack and Portal via PwnSTAR in 2 Minutes
published on June 2012
<small>FH JOANNEUM information management master</small>
</section>
<section id="paper-esecurity-video" data-markdown>
<iframe width="640" height="480" src="//www.youtube.com/embed/vy4leX_twTw" frameborder="0"></iframe>
*"Creating a Rogue Access Point with redirecting web portal and hijacking open wifi users via de-authentication attack."*
</section>
</section>
<!-- ... -->

html example output

<section>
  <section id="paper-esecurity-cover">
    <h3>WLAN Security Revisited (paper)</h3>
    <h4>Rogue AP, Deauthentication Attack and Portal via PwnSTAR in 2 Minutes</h4>
    <p>published on June 2012<br><small>FH JOANNEUM information management master</small></p>
  </section>
  <section id="paper-esecurity-video">
    <p><iframe width="640" height="480" src="//www.youtube.com/embed/vy4leX_twTw" frameborder="0"></iframe><br><em>“Creating a Rogue Access Point with redirecting web portal and hijacking open wifi users via de-authentication attack.”</em></p>
  </section>
</section>

Problems?

File an issue or fork 'n' fix and send a pull request.

License

(c) 2014 Mario Ranftl
MIT License