Skip to content

feat(docs): add clickable anchor links to headings #2053

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

Open
maxffarrell wants to merge 2 commits into
base: main
Choose a base branch
from
Open

feat(docs): add clickable anchor links to headings #2053

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
156bbcb
feat(docs): add clickable anchor links to MDX headings
maxffarrell May 14, 2026
61c44ec
fix(docs): resolve type error in heading components for id prop
maxffarrell May 14, 2026
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
14 changes: 11 additions & 3 deletions docs/src/lib/components/markdown/h1.svelte
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,18 @@
<script lang="ts">
import type { HTMLAttributes } from "svelte/elements";
import { cn } from "$lib/utils/styles.js";
import HeadingAnchor from "./heading-anchor.svelte";

let { class: className, children, ...restProps }: HTMLAttributes<HTMLHeadingElement> = $props();
let {
class: className,
children,
id,
...restProps
}: HTMLAttributes<HTMLHeadingElement> = $props();
</script>

<h1 class={cn("mt-2 scroll-m-20 text-4xl font-bold", className)} {...restProps}>
{@render children?.()}
<h1 class={cn("mt-2 scroll-m-20 text-4xl font-bold", className)} {id} {...restProps}>
<HeadingAnchor id={id ?? undefined}>
{@render children?.()}
</HeadingAnchor>
</h1>
13 changes: 11 additions & 2 deletions docs/src/lib/components/markdown/h2.svelte
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,25 @@
<script lang="ts">
import type { HTMLAttributes } from "svelte/elements";
import { cn } from "$lib/utils/styles.js";
import HeadingAnchor from "./heading-anchor.svelte";

let { class: className, children, ...restProps }: HTMLAttributes<HTMLHeadingElement> = $props();
let {
class: className,
children,
id,
...restProps
}: HTMLAttributes<HTMLHeadingElement> = $props();
</script>

<h2
class={cn(
"mt-12 scroll-m-[70px] text-[27px] font-semibold tracking-[-0.01em] first:mt-0",
className
)}
{id}
{...restProps}
>
{@render children?.()}
<HeadingAnchor id={id ?? undefined}>
{@render children?.()}
</HeadingAnchor>
</h2>
13 changes: 11 additions & 2 deletions docs/src/lib/components/markdown/h3.svelte
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,22 @@
<script lang="ts">
import type { HTMLAttributes } from "svelte/elements";
import { cn } from "$lib/utils/styles.js";
import HeadingAnchor from "./heading-anchor.svelte";

let { class: className, children, ...restProps }: HTMLAttributes<HTMLHeadingElement> = $props();
let {
class: className,
children,
id,
...restProps
}: HTMLAttributes<HTMLHeadingElement> = $props();
</script>

<h3
class={cn("mt-12 scroll-m-[70px] text-xl font-semibold tracking-tight", className)}
{id}
{...restProps}
>
{@render children?.()}
<HeadingAnchor id={id ?? undefined}>
{@render children?.()}
</HeadingAnchor>
</h3>
18 changes: 15 additions & 3 deletions docs/src/lib/components/markdown/h4.svelte
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,22 @@
<script lang="ts">
import type { HTMLAttributes } from "svelte/elements";
import { cn } from "$lib/utils/styles.js";
import HeadingAnchor from "./heading-anchor.svelte";

let { class: className, children, ...restProps }: HTMLAttributes<HTMLHeadingElement> = $props();
let {
class: className,
children,
id,
...restProps
}: HTMLAttributes<HTMLHeadingElement> = $props();
</script>

<h4 class={cn("-mb-2 mt-8 scroll-m-20 text-lg font-bold tracking-tight", className)} {...restProps}>
{@render children?.()}
<h4
class={cn("-mb-2 mt-8 scroll-m-20 text-lg font-bold tracking-tight", className)}
{id}
{...restProps}
>
<HeadingAnchor id={id ?? undefined}>
{@render children?.()}
</HeadingAnchor>
</h4>
18 changes: 15 additions & 3 deletions docs/src/lib/components/markdown/h5.svelte
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,22 @@
<script lang="ts">
import type { HTMLAttributes } from "svelte/elements";
import { cn } from "$lib/utils/styles.js";
import HeadingAnchor from "./heading-anchor.svelte";

let { class: className, children, ...restProps }: HTMLAttributes<HTMLHeadingElement> = $props();
let {
class: className,
children,
id,
...restProps
}: HTMLAttributes<HTMLHeadingElement> = $props();
</script>

<h5 class={cn("mt-8 scroll-m-20 text-lg font-semibold tracking-tight", className)} {...restProps}>
{@render children?.()}
<h5
class={cn("mt-8 scroll-m-20 text-lg font-semibold tracking-tight", className)}
{id}
{...restProps}
>
<HeadingAnchor id={id ?? undefined}>
{@render children?.()}
</HeadingAnchor>
</h5>
18 changes: 15 additions & 3 deletions docs/src/lib/components/markdown/h6.svelte
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,22 @@
<script lang="ts">
import type { HTMLAttributes } from "svelte/elements";
import { cn } from "$lib/utils/styles.js";
import HeadingAnchor from "./heading-anchor.svelte";

let { class: className, children, ...restProps }: HTMLAttributes<HTMLHeadingElement> = $props();
let {
class: className,
children,
id,
...restProps
}: HTMLAttributes<HTMLHeadingElement> = $props();
</script>

<h6 class={cn("mt-8 scroll-m-20 text-base font-semibold tracking-tight", className)} {...restProps}>
{@render children?.()}
<h6
class={cn("mt-8 scroll-m-20 text-base font-semibold tracking-tight", className)}
{id}
{...restProps}
>
<HeadingAnchor id={id ?? undefined}>
{@render children?.()}
</HeadingAnchor>
</h6>
24 changes: 24 additions & 0 deletions docs/src/lib/components/markdown/heading-anchor.svelte
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
<script lang="ts">
import type { Snippet } from "svelte";

let {
id,
children,
}: {
id?: string;
children?: Snippet;
} = $props();
</script>

{#if id}
<a class="group no-underline" href="#{id}">
<span class="underline-offset-4 group-hover:underline">
{@render children?.()}
</span>
<span aria-hidden="true" class="ml-2 text-muted-foreground opacity-0 group-hover:opacity-100">
#
</span>
</a>
{:else}
{@render children?.()}
{/if}