expressjs/expressjs.com

add table of contents

Open

#1 760 ouverte le 4 févr. 2025

Voir sur GitHub
 (4 commentaires) (1 réaction) (0 assignés)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.

Guide contributeur

Stack technique
javascripthtmlcssnodejs
Domaine
documentationfrontend
Type d'issue
feature
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
half day
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
fresh
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
HTMLCSSstatic site generator basics
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70
Direction de recherche
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.