Skip to content

refactor: simplify auto header insertion logic #2578

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.

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
merged 2 commits into from
Aug 2, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 3 additions & 1 deletion docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,9 @@ window.$docsify = {
- Type: `Boolean`
- Default: `false`

If `loadSidebar` and `autoHeader` are both enabled, for each link in `_sidebar.md`, prepend a header to the page before converting it to HTML. See [#78](https://github.com/docsifyjs/docsify/issues/78).
If `loadSidebar` and `autoHeader` are both enabled, for each link in `_sidebar.md`, prepend a header to the page before converting it to HTML — but only if the page does not already contain an H1 heading.

For more details, see [#78](https://github.com/docsifyjs/docsify/issues/78).

```js
window.$docsify = {
Expand Down
14 changes: 9 additions & 5 deletions src/core/render/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -342,11 +342,15 @@ export function Render(Base) {

if (autoHeader && activeEl) {
const main = dom.getNode('#main');
const firstNode = main.children[0];
if (firstNode && firstNode.tagName !== 'H1') {
const h1 = this.compiler.header(activeEl.innerText, 1);
const wrapper = dom.create('div', h1);
dom.before(main, wrapper.children[0]);
const hasH1 = main.querySelector('h1');

if (!hasH1) {
const h1HTML = this.compiler.header(activeEl.innerText, 1);
const h1Node = dom.create('div', h1HTML).firstElementChild;

if (h1Node) {
dom.before(main, h1Node);
}
}
}
}
Expand Down
Loading