expressjs/expressjs.com

add table of contents

Open

#1.760 geöffnet am 4. Feb. 2025

Auf GitHub ansehen
 (4 Kommentare) (1 Reaktion) (0 zugewiesene Personen)CSS (5.330 Stars) (2.088 Forks)batch import
designhelp wantedinvestigate

Beschreibung

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
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
half day
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
fresh
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
HTMLCSSstatic site generator basics
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70
Research-Richtung
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.