expressjs/expressjs.com

add table of contents

Open

#1760 opened on Feb 4, 2025

View on GitHub
 (4 comments) (1 reaction) (0 assignees)CSS (5,330 stars) (2,088 forks)batch import
designhelp wantedinvestigate

Description

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.

Contributor guide

Tech stack
javascripthtmlcssnodejs
Domain
documentationfrontend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
HTMLCSSstatic site generator basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Investigate the current site structure to understand how pages are rendered. Look at Docusaurus and Astro Starlight for table of contents implementation ideas. Review related issue #1759 for context. Examine existing layout templates in the repository to determine where to add the table of contents DOM elements and how to style them.