Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document that getHeadings() only applies to the MDX file, not childre… #7409

Merged
merged 7 commits into from
Mar 16, 2024
Merged

Document that getHeadings() only applies to the MDX file, not childre… #7409

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
7cc8528
Document that getHeadings() only applies to the MDX file, not childre…
matthewp Mar 15, 2024
752096e
sarah tiny edit
sarah11918 Mar 15, 2024
c701c40
Update src/content/docs/en/guides/markdown-content.mdx
sarah11918 Mar 15, 2024
ab200dc
Merge branch 'main' into doc-headings
sarah11918 Mar 15, 2024
06a246e
Merge branch 'main' into doc-headings
sarah11918 Mar 15, 2024
1067eac
more concise!
sarah11918 Mar 16, 2024
06786e0
Merge branch 'main' into doc-headings
sarah11918 Mar 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions src/content/docs/en/guides/markdown-content.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -444,6 +444,10 @@ export default defineConfig({
});
```

:::note
`getHeadings()` only returns the headings written directly in a Markdown or MDX file itself. If an MDX file imports components that contain their own headings, these will not be returned by `getHeadings()`.
:::

#### Customizing a plugin

In order to customize a plugin, provide an options object after it in a nested array.
Expand Down
Loading