Markdown

Markdown files can be optionally pre-processed with an additional template engine. This can be configured on a per-template basis or globally. Read more at Changing a Template’s Rendering Engine.

Markdown Library Options #

Defaults #

• html: true (markdown-it default is false)

The only listed options here are the ones that differ from the default markdown-it options. See all markdown-it options and defaults.

Set your own library instance #

New in Eleventy v0.3.0: Pass in your own instance of the Markdown library using the Configuration API. See all markdown-it options.

module.exports = function(eleventyConfig) {
  let markdownIt = require("markdown-it");
  let options = {
    html: true,
    breaks: true,
    linkify: true
  };
  
  eleventyConfig.setLibrary("md", markdownIt(options));
};

Add your own plugins #

New in Eleventy v0.3.0: Pass in your own markdown-it plugins using the setLibrary Configuration API method (building on the method described in “Using your own options”).

1. Find your own markdown-it plugin on NPM
2. npm install the plugin.

module.exports = function(eleventyConfig) {
  let markdownIt = require("markdown-it");
  let markdownItEmoji = require("markdown-it-emoji");
  let options = {
    html: true
  };
  let markdownLib = markdownIt(options).use(markdownItEmoji);
  
  eleventyConfig.setLibrary("md", markdownLib);
};