Configuring your Markdown engine

specific doc

CloudCannon automatically reads your settings from _config.yml to match editing and builds.

To use Kramdown:

1. Remove or set the markdown field to kramdown in _config.yml
2. Set your options in the kramdown field in _config.yml

kramdown:
  input: GFM
  auto_ids: true

To use CommonMark:

1. Add the jekyll-commonmark gem to your Gemfile
2. Set the markdown field to CommonMark in _config.yml
3. Set your options in the commonmark field in _config.yml

source 'https://rubygems.org'

gem 'jekyll', '3.8.5'

group :jekyll_plugins do
  gem 'jekyll-commonmark', '1.3.1'
end

markdown: CommonMark

commonmark:
  options: ["SMART", "UNSAFE"]
  extensions: ["strikethrough", "table"]

The UNSAFE option is required for HTML content inside your Markdown files to render correctly.

specific doc

CloudCannon automatically reads your Goldmark settings from Hugo to match editing and builds. The settings you set for Goldmark are automatically mapped across to markdown-it.

See the Hugo Documentation for information on how to configure Goldmark. Other engines set with defaultMarkdownHandler are not officially supported.

The UNSAFE option is required for HTML content inside your Markdown files to render correctly.

specific doc

CloudCannon uses the Eleventy default settings for markdown-it to match editing and builds.

The default configuration is { html: true } to match the Eleventy default, but you can update this to match your site by setting the generator.metadata in your global configuration file:

{
  "generator": {
    "metadata": {
      "markdown": "markdown-it",
      "markdown-it": {
        "html": true,
        "linkify": true
      }
    }
  }
}

generator:
  metadata:
    markdown: markdown-it
    markdown-it:
      html: true
      linkify: true

module.exports = {
  generator: {
    metadata: {
      markdown: "markdown-it",
      "markdown-it": {
        html: true,
        linkify: true
      }
    }
  }
};

specific doc

markdown-it is the default Markdown processor in CloudCannon.

The default configuration is { html: true } to allow the images with width and height attributes the Rich Text editors create, but you can update this to match your site by setting the generator.metadata in your global configuration file:

{
  "generator": {
    "metadata": {
      "markdown": "markdown-it",
      "markdown-it": {
        "html": true,
        "linkify": true
      }
    }
  }
}

generator:
  metadata:
    markdown: markdown-it
    markdown-it:
      html: true
      linkify: true

module.exports = {
  generator: {
    metadata: {
      markdown: "markdown-it",
      "markdown-it": {
        html: true,
        linkify: true
      }
    }
  }
};