Skip to content

Fix current page detection for clean URLs #2993

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

Closed
qaqland wants to merge 1 commit into from
Closed

Fix current page detection for clean URLs #2993

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 crates/mdbook-html/front-end/templates/index.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!DOCTYPE HTML>
<html lang="{{ language }}" class="{{ default_theme }} sidebar-visible" dir="{{ text_direction }}">
<html lang="{{ language }}" class="{{ default_theme }} sidebar-visible" dir="{{ text_direction }}" data-current-link="{{ current_link }}">
<head>
<!-- Book generated using mdBook -->
<meta charset="UTF-8">
Expand Down
10 changes: 3 additions & 7 deletions crates/mdbook-html/front-end/templates/toc.js.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,7 @@ class MDBookSidebarScrollbox extends HTMLElement {
connectedCallback() {
this.innerHTML = '{{#toc}}{{/toc}}';
// Set the current, active page, and reveal it if it's hidden
let current_page = document.location.href.toString().split('#')[0].split('?')[0];
if (current_page.endsWith('/')) {
current_page += 'index.html';
}
const current_link = document.documentElement.dataset.currentLink;

@ehuss ehuss May 19, 2026 •
edited by rustbot
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Unfortunately this would be a breaking change if the user has a custom index.hbs. I try to be a little cautious about making those kinds of changes.

View changes since the review

const links = Array.prototype.slice.call(this.querySelectorAll('a'));
const l = links.length;
for (let i = 0; i < l; ++i) {
Expand All @@ -23,10 +20,9 @@ class MDBookSidebarScrollbox extends HTMLElement {
link.href = path_to_root + href;
}
// The 'index' page is supposed to alias the first chapter in the book.
if (link.href === current_page
if (href === current_link
|| i === 0
&& path_to_root === ''
&& current_page.endsWith('/index.html')) {
&& current_link === 'index.html') {
link.classList.add('active');
let parent = link.parentElement;
while (parent) {
Expand Down
6 changes: 6 additions & 0 deletions crates/mdbook-html/src/html_handlebars/hbs_renderer.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,9 @@ impl HtmlHandlebars {
ctx.data.insert("title".to_owned(), json!(title));
ctx.data
.insert("path_to_root".to_owned(), json!(fs::path_to_root(path)));
let current_link = path.with_extension("html").to_url_path();

@ehuss ehuss May 19, 2026 •
edited by rustbot
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I'm noticing that current_link isn't being set in the print page.

I don't think it matters too much because there is no sidebar navigation for the print page.

Offhand I don't think it is required, but I do have a little unease about having a missing variable.

View changes since the review

ctx.data
.insert("current_link".to_owned(), json!(current_link));
if let Some(ref section) = ch.number {
ctx.data
.insert("section".to_owned(), json!(section.to_string()));
Expand Down Expand Up @@ -127,6 +130,8 @@ impl HtmlHandlebars {
ctx.data.insert("path".to_owned(), json!("index.md"));
ctx.data.insert("path_to_root".to_owned(), json!(""));
ctx.data.insert("is_index".to_owned(), json!(true));
ctx.data
.insert("current_link".to_owned(), json!("index.html"));
let rendered_index = ctx.handlebars.render("index", &ctx.data)?;
debug!("Creating index.html from {}", ctx_path);
fs::write(ctx.destination.join("index.html"), rendered_index)?;
Expand Down Expand Up @@ -180,6 +185,7 @@ impl HtmlHandlebars {
// Set a dummy path to ensure other paths (e.g. in the TOC) are generated correctly
data_404.insert("path".to_owned(), json!("404.md"));
data_404.insert("content".to_owned(), json!(html_content_404));
data_404.insert("current_link".to_owned(), json!("404.html"));

@ehuss ehuss May 19, 2026 •
edited by rustbot
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Nothing to change here. Just noting that this isn't technically correct because the output filename can be customized. However, since there isn't anything in the sidebar for it to match, I don't think it matters.

View changes since the review


let mut title = String::from("Page not found");
if let Some(book_title) = &ctx.config.book.title {
Expand Down