Skip to content

add table of contents #1760

Open
1 of 1 issue completed
Open
1 of 1 issue completed
@bjohansebas

Description

@bjohansebas
Member

We should add a table of contents on each page to make it easier to navigate the content.

I would suggest placing the table on the right side, as several site generators do, like Docusaurus or Astro Starlight, and probably adding #1759 at the top or bottom.

Sub-issues

Sub-issues

1 of 1 Issues completed

Activity

bjohansebas

bjohansebas commented on Mar 1, 2025

@bjohansebas
MemberAuthor

We still need to make the TOC generate automatically, we can use this plugin to achieve that

ShubhamOulkar

ShubhamOulkar commented on Mar 9, 2025

@ShubhamOulkar
Member

Hi @bjohansebas, do we really need to generate the TOC? I am asking because we already have written TOC files. So, why should we invest in generating the same HTML again? Unless we want to add the TOC to all website pages, it may not be necessary.

bjohansebas

bjohansebas commented on Mar 10, 2025

@bjohansebas
MemberAuthor

this would help reduce the existing layouts and would prevent the need to manually write the TOC (which is prone to errors). It would also reduce the maintenance load on the page if automated, either with the plugin or another method, while the page is being built.

The TOC is important to me, as it helps quickly navigate to content and enhances the documentation experience.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      Participants

      @ShubhamOulkar@bjohansebas

      Issue actions

        add table of contents · Issue #1760 · expressjs/expressjs.com