Add doc for Blackfriday configuration
authorbep <bjorn.erik.pedersen@gmail.com>
Fri, 26 Dec 2014 15:04:49 +0000 (16:04 +0100)
committerbep <bjorn.erik.pedersen@gmail.com>
Fri, 26 Dec 2014 15:04:49 +0000 (16:04 +0100)
See #686

docs/content/content/front-matter.md
docs/content/overview/configuration.md

index 40e094ef6790da588875d9e749ab58cb2205b603..0f4b1a70a8118eace4b419ff0610c384c9d66d94 100644 (file)
@@ -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.
+
index 9b4b500a1aea4a93e333affc4bc60cb8bf60b94d..118517429cade266a1151e4f6767ec1fb0704651 100644 (file)
@@ -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).