From a0fe117002d7e68a70487c49a88cc81ca773565d Mon Sep 17 00:00:00 2001 From: bep Date: Fri, 26 Dec 2014 16:04:49 +0100 Subject: [PATCH] Add doc for Blackfriday configuration See #686 --- docs/content/content/front-matter.md | 6 ++++++ docs/content/overview/configuration.md | 18 ++++++++++++++++++ 2 files changed, 24 insertions(+) diff --git a/docs/content/content/front-matter.md b/docs/content/content/front-matter.md index 40e094ef6..0f4b1a70a 100644 --- a/docs/content/content/front-matter.md +++ b/docs/content/content/front-matter.md @@ -93,3 +93,9 @@ Field names are always normalized to lowercase (e.g. `camelCase: true` is availa *If neither `slug` or `url` is present, the filename will be used.* +## Configure Blackfriday rendering + +It's possible to set some options for Markdown rendering in the page's front matter, as an override to the site wide configuration. + +See [Configuration]({{< ref "overview/configuration.md" >}}) for more. + diff --git a/docs/content/overview/configuration.md b/docs/content/overview/configuration.md index 9b4b500a1..118517429 100644 --- a/docs/content/overview/configuration.md +++ b/docs/content/overview/configuration.md @@ -63,6 +63,24 @@ Here is a yaml configuration file which sets a few more options SidebarRecentLimit: 5 ... +## Configure Blackfriday rendering + +[Blackfriday](https://github.com/russross/blackfriday) is the [Markdown](http://daringfireball.net/projects/markdown/) rendering engine used in Hugo. The Blackfriday configuration in Hugo is mostly a set of sane defaults that should fit most use cases. + +But Hugo does expose some options -- in the table below matched with the corresponding flag in the [Blackfriday source](https://github.com/russross/blackfriday/blob/master/html.go): + + +Flag | Default | Blackfriday flag | Purpose +--- | --- | --- | --- +angledQuotes | false | HTML_SMARTYPANTS_ANGLED_QUOTES | Enable angled double quotes (`« »`) + +**Note** that these flags must be grouped under the `blackfriday` key and can be set on **both site and page level**. If set on page, it will override the site setting. + +``` +blackfriday: + angledQuotes: true +``` + ## Notes Config changes do not reflect with [Live Reload](/extras/livereload).