commit 029a3ae79e9f1d53a3cbcf577ce65dbf9e4cf6ca
parent 7dacc999f8c0bb2554ddae7a256928b4c499403b
Author: Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>
Date: Fri, 26 Dec 2014 16:56:06 +0100
Merge pull request #742 from bjornerik/doc/blackfriday
Add doc for Blackfriday configuration
Diffstat:
2 files changed, 24 insertions(+), 0 deletions(-)
diff --git 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
@@ -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).