summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>2021-02-07 18:08:46 +0100
committerBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>2021-02-08 19:52:55 +0100
commit2681633db8d340d2dc59cf801419874d572fc704 (patch)
tree74451c9bc4249a387aacf8071127d880cfea07db /docs
parent1b2472825664763c0b88807b0d193e73553423ec (diff)
markup/goldmark: Add attributes support for blocks (tables etc.)
E.g.: ``` > foo > bar {.myclass} ``` There are some current limitations: For tables you can currently only apply it to the full table, and for lists the ul/ol-nodes only, e.g.: ``` * Fruit * Apple * Orange * Banana {.fruits} * Dairy * Milk * Cheese {.dairies} {.list} ``` Fixes #7548
Diffstat (limited to 'docs')
-rw-r--r--docs/content/en/getting-started/configuration-markup.md28
-rw-r--r--docs/data/docs.json15
2 files changed, 40 insertions, 3 deletions
diff --git a/docs/content/en/getting-started/configuration-markup.md b/docs/content/en/getting-started/configuration-markup.md
index ed5163dce..4c4d270a6 100644
--- a/docs/content/en/getting-started/configuration-markup.md
+++ b/docs/content/en/getting-started/configuration-markup.md
@@ -40,6 +40,34 @@ unsafe
typographer
: This extension substitutes punctuations with typographic entities like [smartypants](https://daringfireball.net/projects/smartypants/).
+attribute
+: Enable custom attribute support for titles and blocks by adding attribute lists inside single curly brackets (`{.myclass class="class1 class2" }`) and placing it _after the Markdown element it decorates_, on the same line for titles and on a new line directly below for blocks.
+
+{{< new-in "0.81" >}} In Hugo 0.81.0 we added support for adding attributes (e.g. CSS classes) to Markdown blocks, e.g. tables, lists, paragraphs etc.
+
+A blockquote with a CSS class:
+
+```md
+> foo
+> bar
+{.myclass}
+```
+
+There are some current limitations: For tables you can currently only apply it to the full table, and for lists the `ul`/`ol`-nodes only, e.g.:
+
+```md
+* Fruit
+ * Apple
+ * Orange
+ * Banana
+ {.fruits}
+* Dairy
+ * Milk
+ * Cheese
+ {.dairies}
+{.list}
+```
+
autoHeadingIDType ("github") {{< new-in "0.62.2" >}}
: The strategy used for creating auto IDs (anchor names). Available types are `github`, `github-ascii` and `blackfriday`. `github` produces GitHub-compatible IDs, `github-ascii` will drop any non-Ascii characters after accent normalization, and `blackfriday` will make the IDs work as with [Blackfriday](#blackfriday), the default Markdown engine before Hugo 0.60. Note that if Goldmark is your default Markdown engine, this is also the strategy used in the [anchorize](/functions/anchorize/) template func.
diff --git a/docs/data/docs.json b/docs/data/docs.json
index 70aee718e..8e4b1f95b 100644
--- a/docs/data/docs.json
+++ b/docs/data/docs.json
@@ -1509,7 +1509,10 @@
"parser": {
"autoHeadingID": true,
"autoHeadingIDType": "github",
- "attribute": true
+ "attribute": {
+ "title": true,
+ "block": false
+ }
},
"extensions": {
"typographer": true,
@@ -3023,7 +3026,7 @@
"Examples": []
},
"Merge": {
- "Description": "Merge creates a copy of the final parameter and merges the preceeding\nparameters into it in reverse order.\nCurrently only maps are supported. Key handling is case insensitive.",
+ "Description": "Merge creates a copy of the final parameter and merges the preceding\nparameters into it in reverse order.\nCurrently only maps are supported. Key handling is case insensitive.",
"Args": [
"params"
],
@@ -3526,6 +3529,12 @@
"Aliases": null,
"Examples": null
},
+ "Overlay": {
+ "Description": "",
+ "Args": null,
+ "Aliases": null,
+ "Examples": null
+ },
"Pixelate": {
"Description": "",
"Args": null,
@@ -4371,7 +4380,7 @@
]
},
"CountRunes": {
- "Description": "CountRunes returns the number of runes in s, excluding whitepace.",
+ "Description": "CountRunes returns the number of runes in s, excluding whitespace.",
"Args": [
"s"
],