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.

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

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

Merged

Conversation

JerritEic
Copy link

Describe the PR

Moves the existing table of contents to a floating 'sticky' table of contents in the free space of the upper right side of the documentation pages. On small screens the table of contents is not affected.

Related issues

Ready?

  • Added unit tests for fixed bug/feature
  • Passing all unit tests
  • Complete build ./mvnw clean verify passes (checked automatically by github actions)
  • Added (in-code) documentation (if needed)

@adangel adangel self-requested a review February 25, 2022 09:04
@adangel adangel changed the title Issue2502 add floating table of contents [doc] Add floating table of contents (issue #2502) Feb 25, 2022
@adangel
Copy link
Member

adangel commented Feb 25, 2022

Screenshot:

grafik

Copy link
Member

@adangel adangel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

Originally this was scheduled for PMD7, but I think, it doesn't hurt to merge this already into master (PMD6).

@adangel adangel added this to the 6.43.0 milestone Feb 25, 2022
@adangel adangel added the in:documentation Affects the documentation label Feb 25, 2022
adangel added a commit to adangel/pmd that referenced this pull request Feb 25, 2022
adangel added a commit to adangel/pmd that referenced this pull request Feb 25, 2022
…le-of-contents

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

* pr-3804:
  Add @JerritEic as a contributor
  [doc] Update release notes (pmd#2502 pmd#3804)
  Fix overlap by specifying minimum content div width
  Add responsive floating table-of-contents to documentation website
@adangel adangel merged commit 5d53714 into pmd:master Feb 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
in:documentation Affects the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[doc] Add floating table-of-contents (toc) on the right
2 participants