Skip to content

Commit 3b0cfcb

Browse files
committed
📝 Clarify heading IDs option
1 parent 74c4c30 commit 3b0cfcb

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -317,9 +317,9 @@ This is a {% uppercase(markdown) %} file that is processed by `markdoc-svelte`.
317317

318318
### Heading IDs
319319

320-
If you want to build a table of contents for a page or just have links to specific headings, set `headingIds` to `true.
321-
You can add your own IDs in the original file with [annotations](https://markdoc.dev/docs/syntax#annotations)
322-
or they are generated automatically.
320+
If you want to build a table of contents for a page or just have links to specific headings, set `headingIds` to `true`.
321+
Add unique IDs in the original file with [annotations](https://markdoc.dev/docs/syntax#annotations)
322+
or have them generated automatically.
323323
Each heading element in the generated HTML has an `id` attribute you can use to link to directly.
324324

325325
Each page then also exports a `headings` property: a list of all headings with their text, level, and ID.
@@ -559,7 +559,7 @@ See the example [custom node](#nodes).
559559

560560
### Page table of contents
561561

562-
When you have the [`headingIds` option](#heading-ids) set to `true`,
562+
When you have the [`headingIds` option](#heading-ids) enabled,
563563
each proccessed page automatically exports a `headings` property with all headings on the page and IDs for each.
564564
Use this list to generate a table of contents for the page, as in the following example:
565565

0 commit comments

Comments
 (0)