Skip to content

fix: JSDoc code block syntax in TableOfContents component #431

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

Merged
ainsleyclark merged 3 commits into from
Mar 16, 2026
Merged

fix: JSDoc code block syntax in TableOfContents component #431

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b597bf4
fix(TableOfContents): escape nested HTML comments in @component block
claude Mar 16, 2026
8306ae6
fix(TableOfContents): remove nested HTML comments from @component block
claude Mar 16, 2026
86225e0
chore: add changeset for TableOfContents comment fix
claude Mar 16, 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
5 changes: 5 additions & 0 deletions .changeset/fix-toc-nested-comments.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@ainsleydev/sveltekit-helper": patch
---

Fix `TableOfContents` component erroring at runtime due to nested HTML comments in the `@component` doc block closing the outer comment early, causing Svelte to parse example markup as real template code.
5 changes: 0 additions & 5 deletions packages/sveltekit-helper/src/components/TableOfContents.svelte
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,16 +114,12 @@ export type TableOfContentsProps = {

@example
```svelte
<!-- Attach data attributes to the content element -->
<RichText content={data.body} data-sidebar-content="true" data-sidebar-selector="h3" />

<!-- TOC auto-discovers headings -->
<TableOfContents heading="On this page" />
```

@example
```svelte
<!-- Explicit prop overrides -->
<TableOfContents
contentSelector=".article-body"
headingSelector="h2, h3"
Expand All @@ -134,7 +130,6 @@ export type TableOfContentsProps = {

@example
```svelte
<!-- Manual items (scrollspy still driven by DOM) -->
<TableOfContents items={[{ label: 'Intro', href: 'intro' }]} />
```
-->
Expand Down
Loading