-
Notifications
You must be signed in to change notification settings - Fork 119
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
On large screens, the toc is now anchored to the top right of the screen. A JS-Extension for highlighting the current read progress is provided. On small screens, the toc is hidden and can be opened by the user. - update toc CSS to anchor it to the top right - fall back to inline toc in box on smaller screens (<1000px) - add install instructions for extension - updated browser test information - updated doxygen version recommendation
- Loading branch information
Showing
8 changed files
with
290 additions
and
67 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,82 @@ | ||
| /** | ||
| Doxygen Awesome | ||
| https://github.com/jothepro/doxygen-awesome-css | ||
| MIT License | ||
| Copyright (c) 2022 jothepro | ||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
| in the Software without restriction, including without limitation the rights | ||
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the Software is | ||
| furnished to do so, subject to the following conditions: | ||
| The above copyright notice and this permission notice shall be included in all | ||
| copies or substantial portions of the Software. | ||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| SOFTWARE. | ||
| */ | ||
|
|
||
| class DoxygenAwesomeInteractiveToc { | ||
| static topOffset = 38 | ||
| static hideMobileMenu = true | ||
| static headers = [] | ||
|
|
||
| static init() { | ||
| $(function() { | ||
| $(document).ready(function() { | ||
| let toc = document.querySelector(".contents > .toc") | ||
| toc.classList.add("interactive") | ||
| if(!DoxygenAwesomeInteractiveToc.hideMobileMenu) { | ||
| toc.classList.add("open") | ||
| } | ||
| document.querySelector(".contents > .toc > h3")?.addEventListener("click", () => { | ||
| if(toc.classList.contains("open")) { | ||
| toc.classList.remove("open") | ||
| } else { | ||
| toc.classList.add("open") | ||
| } | ||
|
|
||
| }) | ||
|
|
||
| document.querySelectorAll(".contents > .toc > ul a").forEach((node) => { | ||
| let id = node.getAttribute("href").substring(1) | ||
| DoxygenAwesomeInteractiveToc.headers.push({ | ||
| node: node, | ||
| headerNode: document.getElementById(id) | ||
| }) | ||
|
|
||
| document.getElementById("doc-content")?.addEventListener("scroll", () => { | ||
| DoxygenAwesomeInteractiveToc.update() | ||
| }) | ||
| }) | ||
| DoxygenAwesomeInteractiveToc.update() | ||
| }) | ||
| }) | ||
| } | ||
|
|
||
| static update() { | ||
| let active = DoxygenAwesomeInteractiveToc.headers[0]?.node | ||
| DoxygenAwesomeInteractiveToc.headers.forEach((header) => { | ||
| let position = header.headerNode.getBoundingClientRect().top | ||
| header.node.classList.remove("active") | ||
| header.node.classList.remove("aboveActive") | ||
| if(position < DoxygenAwesomeInteractiveToc.topOffset) { | ||
| active = header.node | ||
| active?.classList.add("aboveActive") | ||
| } | ||
| }) | ||
| active?.classList.add("active") | ||
| active?.classList.remove("aboveActive") | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.