github/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-11-21 20:46:30 -05:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #742 from bjornerik/doc/blackfriday

Browse source 
Add doc for Blackfriday configuration
This commit is contained in:
Bjørn Erik Pedersen 2014-12-26 16:56:06 +01:00
commit 029a3ae79e
2 changed files with 24 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
docs/content/content/front-matter.md
View 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.

18
docs/content/overview/configuration.md
View 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).