diff --git a/content/readfiles/bfconfig.md b/content/readfiles/bfconfig.md index 98e357678..26b078296 100644 --- a/content/readfiles/bfconfig.md +++ b/content/readfiles/bfconfig.md @@ -1,7 +1,9 @@ +## Blackfriday Options + `taskLists` : default: **`true`**
Blackfriday flag:
- Purpose: `false` turns off GitHub-style automatic task/TODO list generation + Purpose: `false` turns off GitHub-style automatic task/TODO list generation. `smartypants` : default: **`true`**
@@ -27,14 +29,14 @@ `smartDashes` : default: **`true`**
Blackfriday flag: **`HTML_SMARTY_DASHES`**
- Purpose: `false` disables smart dashes; i.e., the conversion of multiple hyphens into an en dash or em dash. If `true`, its behavior can be modified with the `latexDashes` flag below. + Purpose: `false` disables smart dashes; i.e., the conversion of multiple hyphens into an en-dash or em-dash. If `true`, its behavior can be modified with the `latexDashes` flag below. `latexDashes` : default: **`true`**
Blackfriday flag: **`HTML_SMARTYPANTS_LATEX_DASHES`**
Purpose: `false` disables LaTeX-style smart dashes and selects conventional smart dashes. Assuming `smartDashes`:
If `true`, `--` is translated into – (`–`), whereas `---` is translated into — (`—`).
- However, *spaced* single hyphen between two words is translated into an en dash— e.g., "`12 June - 3 July`" becomes `12 June ndash; 3 July` upon rendering. + However, *spaced* single hyphen between two words is translated into an en dash— e.g., "`12 June - 3 July`" becomes `12 June – 3 July` upon rendering. `hrefTargetBlank` : default: **`false`**
@@ -51,10 +53,132 @@ : default: **`[]`**
Blackfriday flag: **`EXTENSION_*`**
Purpose: Enable one or more Blackfriday's Markdown extensions (if they aren't Hugo defaults).
- Example: Include `hardLineBreak` in the list to enable Blackfriday's `EXTENSION_HARD_LINK_BREAK` + Example: Include `hardLineBreak` in the list to enable Blackfriday's `EXTENSION_HARD_LINK_BREAK`.
+ *See [Blackfriday extensions]({{< relref "bfconfig.md#blackfriday-extensions" >}}) section for more information.* `extensionsmask` : default: **`[]`**
Blackfriday flag: **`EXTENSION_*`**
Purpose: Enable one or more of Blackfriday's Markdown extensions (if they aren't Hugo defaults).
- Example: Include `autoHeaderIds` as `false` in the list to disable Blackfriday's `EXTENSION_AUTO_HEADER_IDS`. + Example: Include `autoHeaderIds` as `false` in the list to disable Blackfriday's `EXTENSION_AUTO_HEADER_IDS`.
+ *See [Blackfriday extensions]({{< relref "bfconfig.md#blackfriday-extensions" >}}) section for more information.* + +## Blackfriday extensions + +`noIntraEmphasis` +: default: *enabled*
+ Purpose: The "\_" character is commonly used inside words when discussing + code, so having Markdown interpret it as an emphasis command is usually the + wrong thing. When enabled, Blackfriday lets you treat all emphasis markers + as normal characters when they occur inside a word. + +`tables` +: default: *enabled*
+ Purpose: When enabled, tables can be created by drawing them in the input + using the below syntax: + Example: + + Name | Age + --------|------ + Bob | 27 + Alice | 23 + +`fencedCode` +: default: *enabled*
+ Purpose: When enabled, in addition to the normal 4-space indentation to mark + code blocks, you can explicitly mark them and supply a language (to make + syntax highlighting simple). + + You can use 3 or more backticks to mark the beginning of the block, and the + same number to mark the end of the block. + + Example: + + ```md + # Heading Level 1 + Some test + ## Heading Level 2 + Some more test + ``` + +`autolink` +: default: *enabled*
+ Purpose: When enabled, URLs that have not been explicitly marked as links + will be converted into links. + +`strikethrough` +: default: *enabled*
+ Purpose: When enabled, text wrapped with two tildes will be crossed out.
+ Example: `~~crossed-out~~` + +`laxHtmlBlocks` +: default: *disabled*
+ Purpose: When enabled, loosen up HTML block parsing rules. + +`spaceHeaders` +: default: *enabled*
+ Purpose: When enabled, be strict about prefix header rules. + +`hardLineBreak` +: default: *disabled*
+ Purpose: When enabled, newlines in the input translate into line breaks in + the output. + + +`tabSizeEight` +: default: *disabled*
+ Purpose: When enabled, expand tabs to eight spaces instead of four. + +`footnotes` +: default: *enabled*
+ Purpose: When enabled, Pandoc-style footnotes will be supported. The + footnote marker in the text that will become a superscript text; the + footnote definition will be placed in a list of footnotes at the end of the + document.
+ Example: + + This is a footnote.[^1] + + [^1]: the footnote text. + +`noEmptyLineBeforeBlock` +: default: *disabled*
+ Purpose: When enabled, no need to insert an empty line to start a (code, + quote, ordered list, unordered list) block. + + +`headerIds` +: default: *enabled*
+ Purpose: When enabled, allow specifying header IDs with `{#id}`. + +`titleblock` +: default: *disabled*
+ Purpose: When enabled, support [Pandoc-style title blocks][1]. + +`autoHeaderIds` +: default: *enabled*
+ Purpose: When enabled, auto-create the header ID's from the headline text. + +`backslashLineBreak` +: default: *enabled*
+ Purpose: When enabled, translate trailing backslashes into line breaks. + +`definitionLists` +: default: *enabled*
+ Purpose: When enabled, a simple definition list is made of a single-line + term followed by a colon and the definition for that term.
+ Example: + + Cat + : Fluffy animal everyone likes + + Internet + : Vector of transmission for pictures of cats + + Terms must be separated from the previous definition by a blank line. + +`joinLines` +: default: *enabled*
+ Purpose: When enabled, delete newlines and join the lines. + +[1]: http://pandoc.org/MANUAL.html#extension-pandoc_title_block