From b141297651f2e89a1466b39af250f0c5e1b363c6 Mon Sep 17 00:00:00 2001 From: Eric Huss Date: Sun, 28 May 2023 11:31:35 -0700 Subject: [PATCH] Update documentation for heading attributes --- guide/src/format/markdown.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/guide/src/format/markdown.md b/guide/src/format/markdown.md index 84698ca7..8a92870b 100644 --- a/guide/src/format/markdown.md +++ b/guide/src/format/markdown.md @@ -221,7 +221,7 @@ To enable it, see the [`output.html.curly-quotes`] config option. [task list extension]: https://github.github.com/gfm/#task-list-items-extension- [`output.html.curly-quotes`]: configuration/renderers.md#html-renderer-options -### Heading attributes { #headingattributes .class1 .class2 } +### Heading attributes Headings can have a custom HTML ID and classes. This let's you maintain the same ID even if you change the heading's text, it also let's you add multiple classes in the heading. @@ -231,3 +231,5 @@ Example: ``` This makes the level 1 heading with the content `Example heading`, ID `first`, and classes `class1` and `class2`. Note that the attributes should be space-separated. + +More information can be found in the [heading attrs spec page](https://github.com/raphlinus/pulldown-cmark/blob/master/specs/heading_attrs.txt).