Use tocify JS for dynamic TOC [upstream only] #3453
Conversation
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
Lennonka
changed the title
Lennonka
force-pushed
the
expandable-toc-for-foreman-docs
branch
from
6f0bed8
to
95cac8f
Compare
|
A few tweaks and increased levels of headings. It's actually quite cool! 😎 |
guides/common/docinfo.html
Outdated
Comment on lines
2
to
4
| <script src="https://code.jquery.com/jquery-1.11.3.min.js"></script> | ||
| <script src="https://code.jquery.com/ui/1.11.4/jquery-ui.min.js"></script> | ||
| <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery.tocify/1.9.0/javascripts/jquery.tocify.min.js"></script> |
There was a problem hiding this comment.
It would be cool if we checkin these scripts. They are ~350kb in total which is a lot, but I'd be ok with that.
Lennonka
force-pushed
the
expandable-toc-for-foreman-docs
branch
from
95cac8f
to
667a96b
Compare
|
Sourcing the JS libraries locally. And rebased. They have the MIT license - is that compatible with us? I hope I managed to get the JS path correctly. |
Lennonka
commented
Nov 14, 2024
Comment on lines
+2
to
+4
| <script src="/js/jquery-1.11.3.min.js"></script> | ||
| <script src="/js/jquery-ui.min.js"></script> | ||
| <script src="/js/jquery.tocify.min.js"></script> |
There was a problem hiding this comment.
This JS path should be correct because the same path is used to call /js/nav.js but the preview isn't working now and I'm not sure why.
There was a problem hiding this comment.
@ekohl Would you be able to help?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What changes are you introducing?
Making the table of contents expandable and collapsible.
Why are you introducing these changes? (Explanation, links to references, issues, etc.)
Improves UX for Foreman Docs.
For long documents, it's more user friendly and we will be able to display level-3 headings.
Anything else to add? (Considerations, potential downsides, alternative solutions you have explored, etc.)
Checklists
Please cherry-pick my commits into: