71 lines
18 KiB
JavaScript
Raw Normal View History

// Populate the sidebar
//
// This is a script, and not included directly in the page, to control the total size of the book.
// The TOC contains an entry for each page, so if each page includes a copy of the TOC,
// the total size of the page becomes O(n**2).
class MDBookSidebarScrollbox extends HTMLElement {
constructor() {
super();
}
connectedCallback() {
2026-01-17 03:58:28 +00:00
this.innerHTML = '<ol class="chapter"><li class="chapter-item expanded affix "><a href="index.html">Introduction</a></li><li class="chapter-item expanded affix "><li class="spacer"></li><li class="chapter-item expanded affix "><li class="part-title">Getting Started</li><li class="chapter-item expanded "><a href="getting-started/index.html"><strong aria-hidden="true">1.</strong> Getting Started</a></li><li class="chapter-item expanded "><a href="getting-started/prerequisites.html"><strong aria-hidden="true">2.</strong> Prerequisites</a></li><li class="chapter-item expanded "><a href="getting-started/installation.html"><strong aria-hidden="true">3.</strong> Installation</a></li><li class="chapter-item expanded "><a href="getting-started/quick-start.html"><strong aria-hidden="true">4.</strong> Quick Start</a></li><li class="chapter-item expanded "><a href="getting-started/first-deployment.html"><strong aria-hidden="true">5.</strong> First Deployment</a></li><li class="chapter-item expanded "><a href="getting-started/verification.html"><strong aria-hidden="true">6.</strong> Verification</a></li><li class="chapter-item expanded affix "><li class="spacer"></li><li class="chapter-item expanded affix "><li class="part-title">Setup &amp; Configuration</li><li class="chapter-item expanded "><a href="setup/index.html"><strong aria-hidden="true">7.</strong> Setup Overview</a></li><li class="chapter-item expanded "><a href="setup/initial-setup.html"><strong aria-hidden="true">8.</strong> Initial Setup</a></li><li class="chapter-item expanded "><a href="setup/workspace-setup.html"><strong aria-hidden="true">9.</strong> Workspace Setup</a></li><li class="chapter-item expanded "><a href="setup/configuration.html"><strong aria-hidden="true">10.</strong> Configuration Management</a></li><li class="chapter-item expanded affix "><li class="spacer"></li><li class="chapter-item expanded affix "><li class="part-title">User Guides</li><li class="chapter-item expanded "><a href="guides/index.html"><strong aria-hidden="true">11.</strong> Guides Overview</a></li><li class="chapter-item expanded "><a href="guides/from-scratch.html"><strong aria-hidden="true">12.</strong> From Scratch Guide</a></li><li class="chapter-item expanded "><a href="guides/workspace-management.html"><strong aria-hidden="true">13.</strong> Workspace Management</a></li><li class="chapter-item expanded "><a href="guides/multi-cloud-deployment.html"><strong aria-hidden="true">14.</strong> Multi-Cloud Deployment</a></li><li class="chapter-item expanded "><a href="guides/custom-extensions.html"><strong aria-hidden="true">15.</strong> Custom Extensions</a></li><li class="chapter-item expanded "><a href="guides/disaster-recovery.html"><strong aria-hidden="true">16.</strong> Disaster Recovery</a></li><li class="chapter-item expanded affix "><li class="spacer"></li><li class="chapter-item expanded affix "><li class="part-title">Infrastructure as Code</li><li class="chapter-item expanded "><a href="infrastructure/index.html"><strong aria-hidden="true">17.</strong> Infrastructure Overview</a></li><li class="chapter-item expanded "><a href="infrastructure/nickel-guide.html"><strong aria-hidden="true">18.</strong> Nickel Guide</a></li><li class="chapter-item expanded "><a href="infrastructure/configuration-system.html"><strong aria-hidden="true">19.</strong> Configuration System</a></li><li class="chapter-item expanded "><a href="infrastructure/schemas-reference.html"><strong aria-hidden="true">20.</strong> Schemas Reference</a></li><li class="chapter-item expanded "><a href="infrastructure/providers.html"><strong aria-hidden="true">21.</strong> Providers</a></li><li class="chapter-item expanded "><a href="infrastructure/task-services.html"><strong aria-hidden="true">22.</strong> Task Services</a></li><li class="chapter-item expanded "><a href="infrastructure/clusters.html"><strong aria-hidden="true">23.</strong> Clusters</a></li><li class="chapter-item expanded "><a href="infrastructure/batch-workflows.html"><strong aria-hidden="true">24.</strong> Batch Workflows</a></li><li cl
// 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";
}
var links = Array.prototype.slice.call(this.querySelectorAll("a"));
var l = links.length;
for (var i = 0; i < l; ++i) {
var link = links[i];
var href = link.getAttribute("href");
if (href && !href.startsWith("#") && !/^(?:[a-z+]+:)?\/\//.test(href)) {
link.href = path_to_root + href;
}
// The "index" page is supposed to alias the first chapter in the book.
if (link.href === current_page || (i === 0 && path_to_root === "" && current_page.endsWith("/index.html"))) {
link.classList.add("active");
var parent = link.parentElement;
if (parent && parent.classList.contains("chapter-item")) {
parent.classList.add("expanded");
}
while (parent) {
if (parent.tagName === "LI" && parent.previousElementSibling) {
if (parent.previousElementSibling.classList.contains("chapter-item")) {
parent.previousElementSibling.classList.add("expanded");
}
}
parent = parent.parentElement;
}
}
}
// Track and set sidebar scroll position
this.addEventListener('click', function(e) {
if (e.target.tagName === 'A') {
sessionStorage.setItem('sidebar-scroll', this.scrollTop);
}
}, { passive: true });
var sidebarScrollTop = sessionStorage.getItem('sidebar-scroll');
sessionStorage.removeItem('sidebar-scroll');
if (sidebarScrollTop) {
// preserve sidebar scroll position when navigating via links within sidebar
this.scrollTop = sidebarScrollTop;
} else {
// scroll sidebar to current active section when navigating via "next/previous chapter" buttons
var activeSection = document.querySelector('#sidebar .active');
if (activeSection) {
activeSection.scrollIntoView({ block: 'center' });
}
}
// Toggle buttons
var sidebarAnchorToggles = document.querySelectorAll('#sidebar a.toggle');
function toggleSection(ev) {
ev.currentTarget.parentElement.classList.toggle('expanded');
}
Array.from(sidebarAnchorToggles).forEach(function (el) {
el.addEventListener('click', toggleSection);
});
}
}
window.customElements.define("mdbook-sidebar-scrollbox", MDBookSidebarScrollbox);