From ce61e0dfa80e93be7be774a4c7b54e94258ab788 Mon Sep 17 00:00:00 2001
From: Matthias <matthias@endler.dev>
Date: Tue, 8 Oct 2024 15:20:13 +0200
Subject: [PATCH] Document support for anchor links

---
 astro.config.mjs                    |  1 +
 src/content/docs/recipes/anchors.md | 65 +++++++++++++++++++++++++++++
 2 files changed, 66 insertions(+)
 create mode 100644 src/content/docs/recipes/anchors.md

diff --git a/astro.config.mjs b/astro.config.mjs
index c481d20..6522961 100644
--- a/astro.config.mjs
+++ b/astro.config.mjs
@@ -45,6 +45,7 @@ export default defineConfig({
         {
           label: "Recipes",
           items: [
+            { label: "Anchor Links", link: "/recipes/anchors" },
             { label: "Caching", link: "/recipes/caching" },
             { label: "Excluding Links", link: "/recipes/excluding-links" },
             { label: "Excluding Paths", link: "/recipes/excluding-paths" },
diff --git a/src/content/docs/recipes/anchors.md b/src/content/docs/recipes/anchors.md
new file mode 100644
index 0000000..5532be5
--- /dev/null
+++ b/src/content/docs/recipes/anchors.md
@@ -0,0 +1,65 @@
+---
+title: Checking Anchor Links (Fragment Identifiers)
+---
+
+lychee can check anchor links (also called fragments) in both HTML and Markdown files. This feature helps ensure that internal links to specific sections of a page are valid.
+
+## Quick Start
+
+To enable anchor link checking, use the `--include-fragments` flag:
+
+```bash
+lychee --include-fragments 'https://example.com/docs'
+```
+
+## Supported Formats Overview
+
+| Feature                    | Markdown | HTML | Inline HTML in Markdown |
+|----------------------------|----------|------|-------------------------|
+| Heading-based fragments    | ✅        | ✅    | ✅                       |
+| Custom ID fragments        | ✅        | ✅    | ✅                       |
+| Unicode in fragments       | ✅        | ✅    | ✅                       |
+| Inline code in headings    | ✅        | N/A  | N/A                     |
+
+## Detailed Information
+
+### Supported Formats 
+
+- Markdown (.md) files
+- HTML (.html) files
+- Inline HTML within Markdown files
+
+### Supported Anchor Link Types
+
+- Links to headings (e.g., `#introduction`)
+- Links to custom IDs (e.g., `#custom-section-id`)
+- Unicode characters in fragments (e.g., `#résumé`)
+
+### How does lychee generate fragments for comparison?
+
+lychee uses two main methods:
+1. Heading Attributes: For explicit IDs specified in Markdown (e.g., `## My Heading {#custom-id}`)
+2. Unique Kebab Case: For standard headings, similar to GitHub's auto-generated anchors
+
+### Supported Edge Cases
+
+lychee handles:
+
+- Headings with inline code (e.g., ``# `code` in heading``)
+- Unicode characters in headings
+- Underscores in headings (preserved in fragments)
+
+## Limitations
+
+- Complex or nested HTML structures might not be fully supported
+- JavaScript-generated anchors cannot be checked
+- Some advanced Markdown or HTML processor-specific features may not be recognized.
+  Create an issue if you encounter any problems.
+
+## Troubleshooting
+
+In case of issues with anchor link checking, here are some tips:
+
+- Use explicit IDs for complex headings or when targeting specific elements
+- Ensure your Markdown and HTML follow standard practices for heading structures
+- For HTML files, use the `id` attribute on elements you want to link to