Skip to content

highlight nav item in onPageNav ToC when scrolling (add scrollspy) #1024

@bildungsroman

Description

@bildungsroman

🚀 Feature

Highlight the current section in the onPageNav ToC that the reader has scrolled to, either by a background color or bold or adding a customizable CSS class.

Basically, the way scrollspy works in Bootstrap.

Have you read the Contributing Guidelines on issues?

Yup.

Motivation

If a page has a long ToC (i.e. most of our tutorial pages have 9-10 steps), it would make it a lot easier for the reader to know where they are if the current step they have scrolled to is somehow highlighted in the ToC.

Pitch

This could be a universal feature in Docusaurus 2.0. I think it would make Docusaurus sites look even more professional.

Metadata

Metadata

Assignees

No one assigned

    Labels

    featureThis is not a bug or issue with Docusausus, per se. It is a feature request for the future.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions