346b60358d
73a01565c Remove comment shortcode documentation 0ca7ccd30 Replace usage of comment shortcode with HTML comments fe10d9899 Remove expired new-in labels 11e89dfcb [editorial] Link to proper render-hook page in relref.md 11a581c2f netlify: Hugo 0.142.0 1a4fcf7f7 Miscellaneous edits 2c7a3165f Markdown linting and cleanup 69d7a781b Replace links to glossary terms with custom render hook syntax 441752d2d Refactor glossary lookup portion of link render hook 80109a14f Fix glossary term linking for plural form cd95f0f34 Update link render hook to support glossary links 53eadb430 Remove the glossary template 1d40a7f3b Improve transform.ToMath examples 586970df2 Misc edits 6a06a8de7 Add glossary link shortcode 4171c0eb7 Improve description of masking with non-transparent images 41c8feb64 Fix example of image.Mask filter 704a81656 Add alignx option to images.Text usage example 7c03eb0cc Clarify context in example of using the try statement 56d9c9b71 Refactor glossary of terms 042a6846b Add expiry dates to deprecated methods pages 365ab345f Remove services key from instagram shortcode page b7fe31e07 Reorder options list for images.Text filter 8051ff818 Format directory names, file names, and file paths as code d09a14623 Update version refs for Hugo and Dart Sass 3bb006974 Add NODE_VERSION to Netlify config examples 3a0f2531e Fix typo 7e3198eaf Fix typo cf56452a3 Fix typo a9f51d13e Fix typo 82bfdd8c3 Fix typo a5c41a053 Fix typo abcfed7a5 Fix typo 8c1debf3a Remove outdated new-in badges 809ddf9ef Update theme 63867d56f Use warnf instead of errorf in try-catch example dee3e5f09 Update theme 9791f7057 Remove TODO from comment shortcode examples a346ca1fd Elevate embedded shortcode documentation to its own section 8fa19b50f hugoreleaser.toml => hugoreleaser.yaml 575d60345 Update docs for v0.141.0 a0a442d62 netlify: Hugo 0.141.0 6667cbcd8 Merge commit '81a7b6390036138356773c87a886679c81c524e1' f36fc013e docs: Regen CLI docs 365a47ded tpl/images: Change signature of images.QR to images.QR TEXT OPTIONS ae8f8af0a images.Text: Add "alignx" option for horizontal alignment 8f45ccca6 docs: Regen CLI docs f0e6304f4 Merge commit 'e9fbadacc3f09191e2e19f112a49777eeb8df06c' cb9bec2b2 tpl/images: Add images.QR function git-subtree-dir: docs git-subtree-split: 73a01565c5ba0774d65aa6f2384c44804fefa37d
3.1 KiB
| title | description | categories | keywords | menu | weight | toc | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Markdown attributes | Use Markdown attributes to add HTML attributes when rendering Markdown to HTML. |
|
|
|
240 | true |
Overview
Hugo supports Markdown attributes on images and block elements including blockquotes, fenced code blocks, headings, horizontal rules, lists, paragraphs, and tables.
For example:
This is a paragraph.
{class="foo bar" id="baz"}
With class and id you can use shorthand notation:
This is a paragraph.
{.foo .bar #baz}
Hugo renders both of these to:
<p class="foo bar" id="baz">This is a paragraph.</p>
Block elements
Update your site configuration to enable Markdown attributes for block-level elements.
{{< code-toggle file=hugo >}} [markup.goldmark.parser.attribute] title = true # default is true block = true # default is false {{< /code-toggle >}}
Standalone images
By default, when the Goldmark Markdown renderer encounters a standalone image element (no other elements or text on the same line), it wraps the image element within a paragraph element per the CommonMark specification.
If you were to place an attribute list beneath an image element, Hugo would apply the attributes to the surrounding paragraph, not the image.
To apply attributes to a standalone image element, you must disable the default wrapping behavior:
{{< code-toggle file=hugo >}} [markup.goldmark.parser] wrapStandAloneImageWithinParagraph = false # default is true {{< /code-toggle >}}
Usage
You may add global HTML attributes, or HTML attributes specific to the current element type. Consistent with its content security model, Hugo removes HTML event attributes such as onclick and onmouseover.
The attribute list consists of one or more key-value pairs, separated by spaces or commas, wrapped by braces. You must quote string values that contain spaces. Unlike HTML, boolean attributes must have both key and value.
For example:
> This is a blockquote.
{class="foo bar" hidden=hidden}
Hugo renders this to:
<blockquote class="foo bar" hidden="hidden">
<p>This is a blockquote.</p>
</blockquote>
In most cases, place the attribute list beneath the markup element. For headings and fenced code blocks, place the attribute list on the right.
| Element | Position of attribute list |
|---|---|
| blockquote | bottom |
| fenced code block | right |
| heading | right |
| horizontal rule | bottom |
| image | bottom |
| list | bottom |
| paragraph | bottom |
| table | bottom |
For example:
## Section 1 {class=foo}
```bash {class=foo linenos=inline}
declare a=1
echo "${a}"
```
This is a paragraph.
{class=foo}
As shown above, the attribute list for fenced code blocks is not limited to HTML attributes. You can also configure syntax highlighting by passing one or more of these options.