wintersmith-markdown-it v0.1.1

Wintersmith plugin for Markdown-it.

Usage

Add this plugin to your Wintersmith config.json file.

{
  "locals": {
    "title": "Bare minimum wintersmith site"
  },
  "plugins": [
    "../node_modules/wintersmith-markdown-it/"
  ]
}

Presets and Options

Markdown-It can be initialized with various presets and options.

Here is an example enabling typographer and Linkify-It:

{
  "markdown-it": {
    "settings": {
      "linkify": true,
      "typographer": true
    }
  }
}

Here is an example configuring the parser to strict CommonMark mode:

{
  "markdown-it": {
    "settings": "commonmark"
  }
}

Highlight settings

Markdown-It uses highlight.js for syntax highlighting. Two options are exposed:

• class-prefix: String value used to supply a prefix to the CSS classes used by highlight
• auto-language: Boolean flag used to control whether the language is automatically detected for syntax highlighting

Here is an example of specifying both of these configuration options.

{
  "markdown-it": {
    "highlight-settings": {
      "class-prefix": "",
      "auto-language": false
    }
  }
}

Markdown-It Plugins

To use a markdown-it plugin, add it to your package.json as a dependency. Then you must configure the plugin for use.

There are two places to declare markdown-it plugins: in your Wintersmith config.json, or in the metadata for a Wintersmith markdown file. Configurations in the latter take precedence. Put the plugins under the markdown-it property. The options for a plugin can also be specified. If an option value matches /^function\s*\(/ it will be eval'd.

Here's what plugin configuration in config.json looks like:

{
  "locals": {
    "title": "Bare minimum wintersmith site"
  },
  "plugins": [
    "../node_modules/wintersmith-markdown-it/"
  ],
  "markdown-it": {
    "markdown-it-footnote": {},
    "markdown-it-headinganchor": {
      "anchorClass": "my-class-name",
      "addHeadingID": true,
      "addHeadingAnchor": true,
      "slugify": "function (str, md) { return str.replace(/[^a-z0-9]/ig, '-'); }"
    },
  }
}

And here's what plugin configuration in a markdown file looks like:

---
title: Lorem
template: index.jade
markdown-it:
  markdown-it-footnote:
  markdown-it-headinganchor:
     anchorClass: my-class-name,
     addHeadingID: true,
     addHeadingAnchor: true,
     slugify: function (str, md) { return str.replace(/[^a-z0-9]/ig, '-'); }
---

# Title

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.