Skip to content

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

@adangel

Description

@adangel

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/

Metadata

Metadata

Assignees

No one assigned

    Labels

    an:enhancementAn improvement on existing features / rulesin:documentationAffects the documentation [doc]

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions