|
| 1 | +// ref: <https://docs.readthedocs.com/platform/stable/intro/mkdocs.html#integrate-the-read-the-docs-version-menu-into-your-site-navigation> |
| 2 | + |
| 3 | +document.addEventListener("DOMContentLoaded", function (event) { |
| 4 | + // Trigger Read the Docs' search addon instead of Material MkDocs default |
| 5 | + document.querySelector(".md-search__input").addEventListener("focus", (e) => { |
| 6 | + const event = new CustomEvent("readthedocs-search-show"); |
| 7 | + document.dispatchEvent(event); |
| 8 | + }); |
| 9 | +}); |
| 10 | + |
| 11 | +// Use CustomEvent to generate the version selector |
| 12 | +document.addEventListener("readthedocs-addons-data-ready", function (event) { |
| 13 | + const config = event.detail.data(); |
| 14 | + const versioning = ` |
| 15 | +<div class="md-version"> |
| 16 | +<button class="md-version__current" aria-label="Select version"> |
| 17 | + ${config.versions.current.slug} |
| 18 | +</button> |
| 19 | +
|
| 20 | +<ul class="md-version__list"> |
| 21 | +${config.versions.active |
| 22 | + .map( |
| 23 | + (version) => ` |
| 24 | + <li class="md-version__item"> |
| 25 | + <a href="${version.urls.documentation}" class="md-version__link"> |
| 26 | + ${version.slug} |
| 27 | + </a> |
| 28 | + </li>`, |
| 29 | + ) |
| 30 | + .join("\n")} |
| 31 | +</ul> |
| 32 | +</div>`; |
| 33 | + |
| 34 | + // Check if we already added versions and remove them if so. |
| 35 | + // This happens when using the "Instant loading" feature. |
| 36 | + // See https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#instant-loading |
| 37 | + const currentVersions = document.querySelector(".md-version"); |
| 38 | + if (currentVersions !== null) { |
| 39 | + currentVersions.remove(); |
| 40 | + } |
| 41 | + document |
| 42 | + .querySelector(".md-header__topic") |
| 43 | + .insertAdjacentHTML("beforeend", versioning); |
| 44 | +}); |
0 commit comments