Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[doc] Add floating table-of-contents (toc) on the right #2502

Closed
adangel opened this issue May 20, 2020 · 0 comments · Fixed by #3804
Closed

[doc] Add floating table-of-contents (toc) on the right #2502

adangel opened this issue May 20, 2020 · 0 comments · Fixed by #3804
Labels
an:enhancement An improvement on existing features / rules in:documentation Affects the documentation
Milestone
6.43.0

Comments

@adangel
Copy link
Member

adangel commented May 20, 2020 •
edited

Part of #1139 . Note: fixed in PMD 6.43.0 already.

This is especially useful for pages that are bigger than one screen. We have some space
on the right of the screen, where we can display a sticky toc box.

Note: for the mobile usage of the page, we probably have no space to have this toc always
visible. So for the start, we don't provide this here.

Possible library to use: https://afeld.github.io/bootstrap-toc/
@adangel adangel added an:enhancement An improvement on existing features / rules in:documentation Affects the documentation labels May 20, 2020
@adangel adangel added this to the 7.0.0 milestone May 20, 2020
@oowekyala oowekyala mentioned this issue May 20, 2020
Closed
13 tasks
@JerritEic JerritEic mentioned this issue Feb 23, 2022
Merged
4 tasks
@adangel adangel modified the milestones: 7.0.0, 6.43.0 Feb 25, 2022
adangel added a commit that referenced this issue Feb 25, 2022
@adangel
[doc] Update release notes (#2502 #3804)
cf2781c
adangel added a commit that referenced this issue Feb 25, 2022
@adangel
Merge pull request #3804 from JerritEic:issue2502-Add-floating-table-…
36134ed 
…of-contents

[doc] Add floating table of contents (issue #2502) #3804

* pr-3804:
  Add @JerritEic as a contributor
  [doc] Update release notes (#2502 #3804)
  Fix overlap by specifying minimum content div width
  Add responsive floating table-of-contents to documentation website
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
an:enhancement An improvement on existing features / rules in:documentation Affects the documentation
Projects
None yet
Milestone
6.43.0
Development

Successfully merging a pull request may close this issue.

[doc] Add floating table of contents (issue #2502) JerritEic/pmd
1 participant
@adangel