summaryrefslogtreecommitdiffstats
path: root/content/en/readfiles/bfconfig.md
diff options
context:
space:
mode:
authorBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>2019-12-15 10:35:09 +0100
committerBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>2019-12-15 10:35:09 +0100
commit2e711a28c71e8667258e5ab824f9b9a71c261b0a (patch)
tree70b7061711891111a68c535674f3a02056770ce2 /content/en/readfiles/bfconfig.md
parentefc0b1bb6c6564f54d596467dbc6a18cb206954e (diff)
Squashed 'docs/' changes from 51c4f3184..af4b7ac5b
af4b7ac5b Remove mention of Amber and Ace c841e9207 Exif docs corrections (#978) 0f82420b8 Change cache assets default example to 1 year 676dc6e12 Release 0.61.0 a1d9fb18a Merge commit '79c5d7053486f540b6219e693d5590f2c4c3937a' 1b9e675cd releaser: Add release notes to /docs for release of 0.61.0 5b95cbc8a Fixed suffixIsRemoved error in code samples (#975) 59b2c245b Fix Usage section in toc.md to consider Goldmark TOC settings fd3828673 Add link on how to configure TOC w/ Goldmark ea339f2d6 Added external learning resources including Hugo In Action book. fab502d5d Adjust release notes 269a025ef Release 0.60.1 6bff50bea Merge branch 'temp601' e15251c43 releaser: Add release notes to /docs for release of 0.60.1 690b864b9 Update use-modules.md 345ca8c36 Update syntax-highlighting.md be64af9f5 Update syntax-highlighting.md df9dead83 Update syntax-highlighting.md 1c6e6d238 Fix relnotes 0ea6b2012 Update homepagetweets.toml 2c465625d Update index.md 0025bba09 Update index.md 7417f1c05 Update index.md 9eeb8ce57 Release 0.60.0 25a711023 Merge branch 'temp60' 0c4faab0e releaser: Add release notes to /docs for release of 0.60.0 779e5108e Update installing.md 2ef1c386a Minor text improvements in README.md 41ec5a19a Reword sentence for clarity search.md ded74f098 Add Goldmark as the new default markdown handler cb55cdbb0 Update introduction.md fcaad653a Update homepage.md 7427a1fc5 Update configuration.md 8cc2c72ca tpl/collections: Allow dict to create nested structures 4538c092c Merge commit 'efc0b1bb6c6564f54d596467dbc6a18cb206954e' 90f908e7b Support Go time format strings in permalinks git-subtree-dir: docs git-subtree-split: af4b7ac5b403e392a92228e66058331905fff7dc
Diffstat (limited to 'content/en/readfiles/bfconfig.md')
-rw-r--r--content/en/readfiles/bfconfig.md197
1 files changed, 0 insertions, 197 deletions
diff --git a/content/en/readfiles/bfconfig.md b/content/en/readfiles/bfconfig.md
deleted file mode 100644
index 95941234d..000000000
--- a/content/en/readfiles/bfconfig.md
+++ /dev/null
@@ -1,197 +0,0 @@
-## Blackfriday Options
-
-`taskLists`
-: default: **`true`**<br>
- Blackfriday flag: <br>
- Purpose: `false` turns off GitHub-style automatic task/TODO list generation.
-
-`smartypants`
-: default: **`true`** <br>
- Blackfriday flag: **`HTML_USE_SMARTYPANTS`** <br>
- Purpose: `false` disables smart punctuation substitutions, including smart quotes, smart dashes, smart fractions, etc. If `true`, it may be fine-tuned with the `angledQuotes`, `fractions`, `smartDashes`, and `latexDashes` flags (see below).
-
-`smartypantsQuotesNBSP`
-: default: **`false`** <br>
- Blackfriday flag: **`HTML_SMARTYPANTS_QUOTES_NBSP`** <br>
- Purpose: `true` enables French style Guillemets with non-breaking space inside the quotes.
-
-`angledQuotes`
-: default: **`false`**<br>
- Blackfriday flag: **`HTML_SMARTYPANTS_ANGLED_QUOTES`**<br>
- Purpose: `true` enables smart, angled double quotes. Example: "Hugo" renders to «Hugo» instead of “Hugo”.
-
-`fractions`
-: default: **`true`**<br>
- Blackfriday flag: **`HTML_SMARTYPANTS_FRACTIONS`** <br>
- Purpose: <code>false</code> disables smart fractions.<br>
- Example: `5/12` renders to <sup>5</sup>&frasl;<sub>12</sub>(<code>&lt;sup&gt;5&lt;/sup&gt;&amp;frasl;&lt;sub&gt;12&lt;/sub&gt;</code>).<br> <small><strong>Caveat:</strong> Even with <code>fractions = false</code>, Blackfriday still converts `1/2`, `1/4`, and `3/4` respectively to ½ (<code>&amp;frac12;</code>), ¼ (<code>&amp;frac14;</code>) and ¾ (<code>&amp;frac34;</code>), but only these three.</small>
-
-`smartDashes`
-: default: **`true`** <br>
- Blackfriday flag: **`HTML_SMARTY_DASHES`** <br>
- 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`** <br>
- Blackfriday flag: **`HTML_SMARTYPANTS_LATEX_DASHES`** <br>
- Purpose: `false` disables LaTeX-style smart dashes and selects conventional smart dashes. Assuming `smartDashes`: <br>
- If `true`, `--` is translated into &ndash; (`&ndash;`), whereas `---` is translated into &mdash; (`&mdash;`). <br>
- However, *spaced* single hyphen between two words is translated into an en&nbsp;dash&mdash; e.g., "`12 June - 3 July`" becomes `12 June &ndash; 3 July` upon rendering.
-
-`hrefTargetBlank`
-: default: **`false`** <br>
- Blackfriday flag: **`HTML_HREF_TARGET_BLANK`** <br>
- Purpose: `true` opens <s>external links</s> **absolute** links in a new window or tab. While the `target="_blank"` attribute is typically used for external links, Blackfriday does that for _all_ absolute links ([ref](https://discourse.gohugo.io/t/internal-links-in-same-tab-external-links-in-new-tab/11048/8)). One needs to make note of this if they use absolute links throughout, for internal links too (for example, by setting `canonifyURLs` to `true` or via `absURL`).
-
-`nofollowLinks`
-: default: **`false`** <br>
- Blackfriday flag: **`HTML_NOFOLLOW_LINKS`** <br>
- Purpose: `true` creates <s>external links</s> **absolute** links with `nofollow` being added to their `rel` attribute. Thereby crawlers are advised to not follow the link. While the `rel="nofollow"` attribute is typically used for external links, Blackfriday does that for _all_ absolute links. One needs to make note of this if they use absolute links throughout, for internal links too (for example, by setting `canonifyURLs` to `true` or via `absURL`).
-
-`noreferrerLinks`
-: default: **`false`** <br>
- Blackfriday flag: **`HTML_NOREFERRER_LINKS`** <br>
- Purpose: `true` creates <s>external links</s> **absolute** links with `noreferrer` being added to their `rel` attribute. Thus when following the link no referrer information will be leaked. While the `rel="noreferrer"` attribute is typically used for external links, Blackfriday does that for _all_ absolute links. One needs to make note of this if they use absolute links throughout, for internal links too (for example, by setting `canonifyURLs` to `true` or via `absURL`).
-
-`plainIDAnchors`
-: default **`true`** <br>
- Blackfriday flag: **`FootnoteAnchorPrefix` and `HeaderIDSuffix`** <br>
- Purpose: `true` renders any heading and footnote IDs without the document ID. <br>
- Example: renders `#my-heading` instead of `#my-heading:bec3ed8ba720b970`
-
-`extensions`
-: default: **`[]`** <br>
- Purpose: Enable one or more Blackfriday's Markdown extensions (**`EXTENSION_*`**). <br>
- Example: Include `hardLineBreak` in the list to enable Blackfriday's `EXTENSION_HARD_LINE_BREAK`. <br>
- *See [Blackfriday extensions](#blackfriday-extensions) section for information on all extensions.*
-
-`extensionsmask`
-: default: **`[]`** <br>
- Purpose: Disable one or more of Blackfriday's Markdown extensions (**`EXTENSION_*`**). <br>
- Example: Include `autoHeaderIds` as `false` in the list to disable Blackfriday's `EXTENSION_AUTO_HEADER_IDS`. <br>
- *See [Blackfriday extensions](#blackfriday-extensions) section for information on all extensions.*
-
-`skipHTML`
-: default: **`false`** <br>
- Blackfriday flag: **`HTML_SKIP_HTML`** <br>
- Purpose: `true` causes any HTML in the markdown files to be skipped.
-
-## Blackfriday extensions
-
-`noIntraEmphasis`
-: default: *enabled* <br>
- 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* <br>
- 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* <br>
- 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* <br>
- Purpose: When enabled, URLs that have not been explicitly marked as links
- will be converted into links.
-
-`strikethrough`
-: default: *enabled* <br>
- Purpose: When enabled, text wrapped with two tildes will be crossed out. <br>
- Example: `~~crossed-out~~`
-
-`laxHtmlBlocks`
-: default: *disabled* <br>
- Purpose: When enabled, loosen up HTML block parsing rules.
-
-`spaceHeaders`
-: default: *enabled* <br>
- Purpose: When enabled, be strict about prefix header rules.
-
-`hardLineBreak`
-: default: *disabled* <br>
- Purpose: When enabled, newlines in the input translate into line breaks in
- the output.
-
-
-`tabSizeEight`
-: default: *disabled* <br>
- Purpose: When enabled, expand tabs to eight spaces instead of four.
-
-`footnotes`
-: default: *enabled* <br>
- 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. <br>
- Example:
-
- This is a footnote.[^1]
-
- [^1]: the footnote text.
-
-`noEmptyLineBeforeBlock`
-: default: *disabled* <br>
- Purpose: When enabled, no need to insert an empty line to start a (code,
- quote, ordered list, unordered list) block.
-
-
-`headerIds`
-: default: *enabled* <br>
- Purpose: When enabled, allow specifying header IDs with `{#id}`.
-
-`titleblock`
-: default: *disabled* <br>
- Purpose: When enabled, support [Pandoc-style title blocks][1].
-
-`autoHeaderIds`
-: default: *enabled* <br>
- Purpose: When enabled, auto-create the header ID's from the headline text.
-
-`backslashLineBreak`
-: default: *enabled* <br>
- Purpose: When enabled, translate trailing backslashes into line breaks.
-
-`definitionLists`
-: default: *enabled* <br>
- Purpose: When enabled, a simple definition list is made of a single-line
- term followed by a colon and the definition for that term. <br>
- 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* <br>
- Purpose: When enabled, delete newlines and join the lines.
-
-[1]: http://pandoc.org/MANUAL.html#extension-pandoc_title_block