Skip to content

[3.x] Strip Markdown from sidebar table of contents #2608

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
emmadesilva merged 1 commit into from
Sep 4, 2026
Merged

[3.x] Strip Markdown from sidebar table of contents #2608

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion packages/framework/src/Framework/Actions/GeneratesTableOfContents.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ protected function isHeadingWithinBounds(array $heading): bool
protected function createTableItem(array $heading): array
{
return [
'title' => $heading['title'],
'title' => (new ConvertsMarkdownToPlainText($heading['title']))->execute(),
'identifier' => $heading['identifier'],
'children' => [],
];
Expand Down
13 changes: 13 additions & 0 deletions packages/framework/tests/Unit/GeneratesSidebarTableOfContentsTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,19 @@ public function testNonHeadingMarkdownIsIgnored()
);
}

public function testMarkdownIsStrippedFromHeadingTitles()
{
$markdown = '## To learn more, head over to the [Quickstart page](quickstart).';

$this->assertSame([
[
'title' => 'To learn more, head over to the Quickstart page.',
'identifier' => 'to-learn-more-head-over-to-the-quickstart-pagequickstart',
'children' => [],
],
], (new GeneratesTableOfContents($markdown))->execute());
}

public function testWithNoLevelOneHeading()
{
$markdown = <<<'MARKDOWN'
Expand Down
Loading