Skip to content

Latest commit

 

History

History
34 lines (25 loc) · 1.31 KB

readme.md

File metadata and controls

34 lines (25 loc) · 1.31 KB

wintersmith-showdown

Showdown plugin for wintersmith. Renders Markdown content using (a modified version of) Showdown instead of the default, marked. While slower to render, this enables lots of Markdown extras such as footnotes, tables, strikethrough, LaTeX math (via MathML), and smart punctuation. Also adds extremely inefficient code highlighting via highlight.js.

This is a very rough, initial release. Use at your own risk!

install:

npm install git://github.com/lhagan/wintersmith-showdown.git

then add ./node_modules/wintersmith-showdown/ to config.json like this:

{
  "locals": {
    "url": "http://localhost:8080",
    "name": "The Wintersmith's blog",
    "owner": "The Wintersmith",
    "description": "-32°C ain't no problems!",
    "index_articles": 3
  },
  "plugins": [
    "./node_modules/wintersmith-showdown/"
  ]
}

per-page showdown extensions

By default, all extensions are enabled. For more fine-grained control, include showdownExtensions in your page metadata. For example:

---
title: Wintersmith Showdown
template: index.jade
showdownExtensions: ['github', 'smartypants']
---