theforeman / foreman-documentation

Documentation for the Foreman Project and its ecosystem
https://docs.theforeman.org
Creative Commons Attribution Share Alike 4.0 International
22 stars 95 forks source link

Use tocify JS for dynamic TOC [upstream only] #3453

Open Lennonka opened 1 week ago

Lennonka commented 1 week ago

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:

github-actions[bot] commented 1 week ago

The PR preview for 667a96b9296b654544debed5ab8523ee0c66eba4 is available at theforeman-foreman-documentation-preview-pr-3453.surge.sh

The following output files are affected by this PR:

show diff

show diff as HTML

Lennonka commented 1 week ago

A few tweaks and increased levels of headings.

It's actually quite cool! :sunglasses:

Lennonka commented 1 week ago

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.