From 8f285baa3e869d4a732a1c471780d90c5b856c1f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Elian=20=E2=98=95=EF=B8=8F?= Date: Tue, 7 Nov 2023 11:35:47 +0100 Subject: [PATCH] add note on linking to headings (#5300) Co-authored-by: Chris Swithinbank --- src/content/docs/en/guides/markdown-content.mdx | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/content/docs/en/guides/markdown-content.mdx b/src/content/docs/en/guides/markdown-content.mdx index 876d763f3b196..7690ca3990988 100644 --- a/src/content/docs/en/guides/markdown-content.mdx +++ b/src/content/docs/en/guides/markdown-content.mdx @@ -119,6 +119,8 @@ I can link internally to [my conclusion](#conclusion) on the same page when writ I can use the URL `https://example.com/page-1/#introduction` to navigate directly to my Introduction on the page. ``` +Astro generates heading `id`s based on `github-slugger`. You can find more examples in [the github-slugger documentation](https://github.com/Flet/github-slugger#usage). + ### Escaping special characters Certain characters have a special meaning in Markdown and MDX. You may need to use a different syntax if you want to display them. To do this, you can use [HTML entities](https://developer.mozilla.org/en-US/docs/Glossary/Entity) for these characters instead.