Skip to content

fix: exclude headings inside blockquotes from sidebar TOC #2691

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
Bowl42 wants to merge 3 commits into
base: develop
Choose a base branch
from
Open

fix: exclude headings inside blockquotes from sidebar TOC #2691

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
0243d4d
fix: exclude headings inside blockquotes from sidebar TOC
Bowl42 Mar 4, 2026
801c82b
fix: use depth counter for nested blockquotes and add try/finally
Bowl42 Mar 4, 2026
77484fc
style: fix prettier formatting in blockquoteCompiler call
Bowl42 Mar 4, 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
6 changes: 5 additions & 1 deletion src/core/render/compiler.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ export class Compiler {
this.router = router;
this.cacheTree = {};
this.toc = [];
this.blockquoteDepth = 0;
this.cacheTOC = {};
this.linkTarget = config.externalLinkTarget || '_blank';
this.linkRel =
Expand Down Expand Up @@ -165,7 +166,10 @@ export class Compiler {
router,
compiler: this,
});
origin.blockquoteCompiler = blockquoteCompiler({ renderer });
origin.blockquoteCompiler = blockquoteCompiler({
renderer,
compiler: this,
});
origin.code = highlightCodeCompiler({ renderer });
origin.link = linkCompiler({
renderer,
Expand Down
11 changes: 8 additions & 3 deletions src/core/render/compiler/blockquote.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
export const blockquoteCompiler = ({ renderer }) =>
export const blockquoteCompiler = ({ renderer, compiler }) =>
(renderer.blockquote = function ({ tokens }) {
let openTag = '<blockquote>';
let closeTag = '</blockquote>';
Expand Down Expand Up @@ -40,6 +40,11 @@ export const blockquoteCompiler = ({ renderer }) =>
}
}

const body = this.parser.parse(tokens);
return `${openTag}${body}${closeTag}`;
compiler.blockquoteDepth++;
try {
const body = this.parser.parse(tokens);
return `${openTag}${body}${closeTag}`;
} finally {
compiler.blockquoteDepth--;
}
Comment on lines +43 to +49
Copy link
Member

@sy-records sy-records Mar 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
compiler.blockquoteDepth++;
try {
const body = this.parser.parse(tokens);
return `${openTag}${body}${closeTag}`;
} finally {
compiler.blockquoteDepth--;
}
this.__docsifyBlockquoteDepth = (this.__docsifyBlockquoteDepth || 0) + 1;
let body;
try {
body = this.parser.parse(tokens);
} finally {
this.__docsifyBlockquoteDepth = Math.max(0, this._blockquoteDepth - 1);
}

});
4 changes: 3 additions & 1 deletion src/core/render/compiler/heading.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,9 @@ export const headingCompiler = ({ renderer, router, compiler }) =>
const slug = slugify(config.id || text);
const url = router.toURL(router.getCurrentPath(), { id: slug });
nextToc.slug = stripUrlExceptId(url);
compiler.toc.push(nextToc);
if (!compiler.blockquoteDepth) {
compiler.toc.push(nextToc);
}
Comment on lines +25 to +27
Copy link
Member

@sy-records sy-records Mar 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
if (!compiler.blockquoteDepth) {
compiler.toc.push(nextToc);
}
if (!this.__docsifyBlockquoteDepth || this.__docsifyBlockquoteDepth === 0) {
compiler.toc.push(nextToc);
}


// Note: tabindex="-1" allows programmatically focusing on heading
// elements after navigation. This is preferred over focusing on the link
Expand Down
Loading