docs: Don't render the table of contents on the print page (#12340)

This commit is contained in:
Andrew Morgan 2022-04-13 08:27:51 -07:00 committed by GitHub
parent 73d8ded0b0
commit 0922462fc7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 15 additions and 0 deletions

1
changelog.d/12340.doc Normal file
View file

@ -0,0 +1 @@
Fix rendering of the documentation site when using the 'print' feature.

View file

@ -75,6 +75,20 @@ function setTocEntry() {
* Populate sidebar on load * Populate sidebar on load
*/ */
window.addEventListener('load', () => { window.addEventListener('load', () => {
// Prevent rendering the table of contents of the "print book" page, as it
// will end up being rendered into the output (in a broken-looking way)
// Get the name of the current page (i.e. 'print.html')
const pageNameExtension = window.location.pathname.split('/').pop();
// Split off the extension (as '.../print' is also a valid page name), which
// should result in 'print'
const pageName = pageNameExtension.split('.')[0];
if (pageName === "print") {
// Don't render the table of contents on this page
return;
}
// Only create table of contents if there is more than one header on the page // Only create table of contents if there is more than one header on the page
if (headers.length <= 1) { if (headers.length <= 1) {
return; return;