Skip to content

Update readthedocs.js to latest zensical example #1558

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
tleonhardt merged 1 commit into from
Jan 21, 2026
+3 −40
Merged

Update readthedocs.js to latest zensical example #1558

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
29 changes: 2 additions & 27 deletions docs/javascripts/readthedocs.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,33 +1,8 @@
document.addEventListener("DOMContentLoaded", function (event) {
// Trigger Read the Docs' search addon instead of Zensical default
document.querySelector(".md-search__input").addEventListener("focus", (e) => {
document.querySelector(".md-search").addEventListener("click", (e) => {
e.preventDefault();
const event = new CustomEvent("readthedocs-search-show");
document.dispatchEvent(event);
});
});

// Use CustomEvent to generate the version selector
document.addEventListener("readthedocs-addons-data-ready", function (event) {
const config = event.detail.data();
const versioning = `
<div class="md-version">
<button class="md-version__current" aria-label="Select version">
${config.versions.current.slug}
</button>

<ul class="md-version__list">
${config.versions.active
.map(
(version) => `
<li class="md-version__item">
<a href="${version.urls.documentation}" class="md-version__link">
${version.slug}
</a>
</li>`,
)
.join("\n")}
</ul>
</div>`;

document.querySelector(".md-header__topic").insertAdjacentHTML("beforeend", versioning);
});
11 changes: 0 additions & 11 deletions docs/stylesheets/readthedocs.css
View file
Open in desktop

This file was deleted.

3 changes: 1 addition & 2 deletions mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -217,10 +217,9 @@ nav:
- Meta:
- doc_conventions.md

# Include extra CSS to make some style adjustments for ReadTheDocs
# Include extra CSS to make some style adjustments for visible width
extra_css:
- stylesheets/cmd2.css
- stylesheets/readthedocs.css

# Include extra JS to setup Read the Docs addons integrations
extra_javascript:
Expand Down
Loading