mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-14 20:37:55 -05:00
f3cd083961
fc61378a3 Add Hugo 0.32 related docs 77edf7fd7 commands: Regenerate af9d25458 Fix Blackfriday's Markdown extension name 1223dd63a Remove roadmap b8bcb2fb8 Include note to allow hugo write permissions outside home dir 7dbccb936 Fix typo in roadmap 3a38da6f5 Fix spelling 94ebe50ff Merge branch 'master' of github.com:gohugoio/hugoDocs 89376e21d Clarify Hugo Roadmap 03d191fec Mention Reverse function in taxonomy tpl page. a4ea3402d Fix ref and relref function pages. b36632b31 Remove non-existing source variable a638160dc Update Content Organization to match the world 47eb431ca Correct one link in templates/output-formats.md 8bf933629 Spell fix ce2d48728 Add docs for .AllTranslations de94b4942 Move sponsor data to theme data 41fe75254 Merge commit 'f463ef99ed2862e4042557e28aece7ca858e1d0a' f463ef99e Squashed 'themes/gohugoioTheme/' changes from bc851da9..75da2f6b 532c65f2a Move sponsor logo to theme 899e2defe Add sponsor logos to home page and footer 3ca53db97 Release 0.31.1 bb9876ce2 Merge branch 'temp0311' c7c3ee7e5 releaser: Prepare repository for 0.32-DEV 4ac554792 releaser: Add release notes to /docs for release of 0.31.1 52bfb5c15 releaser: Bump versions for release of 0.31.1 cfdc2e4ea Fix output formats example 5746c10c2 More on output format de2ee0fe0 Improve suffix redefinition example c9997839e Update gitlab CI submodule management 82d74e306 Add Bootstrap styling to breadcrumb example c8c9601a8 Use the code shortcode for the breadcrumb example 16be43e7d Clean up formatting in variable definition lists 149c2c157 Add nested section docs 783c3d636 Sync theme 60a220bbd Squashed 'themes/gohugoioTheme/' changes from 6b632895..bc851da9 4b33a04d0 Fix typo 94cffc43c Fix little typo a5d4f762f Fix typo 36c5a0b43 Add a note about the 2 in staticDir2 087bd9a9f Add KeyCDN to menu 4ac8aae38 Hugo 0.31 Released 8fdd995e7 releaser: Prepare repository for 0.32-DEV eb0f38fbb releaser: Add release notes to /docs for release of 0.31 60efdfff7 releaser: Bump versions for release of 0.31 44dafb10b Merge commit '30c0d485eaff6d70df1be0353911ddca485d52bf' e6b847b95 Merge commit '05e42bc643f1840ed2ad9c2eff82a269d1381683' 15d86a525 Handle Taxonomy permalinks 5c3c18d7f Add support for height argument to figure shortcode git-subtree-dir: docs git-subtree-split: fc61378a3227c14883a2942d67c806014e7bb6cb
182 lines
6.8 KiB
Markdown
182 lines
6.8 KiB
Markdown
## 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>⁄<sub>12</sub>(<code><sup>5</sup>&frasl;<sub>12</sub></code>).<br> <strong>Caveat:</strong> Even with <code>fractions = false</code>, Blackfriday still converts `1/2`, `1/4`, and `3/4` respectively to ½ (<code>&frac12;</code>), ¼ (<code>&frac14;</code>) and ¾ (<code>&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 – (`–`), whereas `---` is translated into — (`—`). <br>
|
|
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`** <br>
|
|
Blackfriday flag: **`HTML_HREF_TARGET_BLANK`** <br>
|
|
Purpose: `true` opens external links in a new window or tab.
|
|
|
|
`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.*
|
|
|
|
## 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
|