expressjs/expressjs.com

add table of contents

Fermée

#1 760 ouverte le 4 févr. 2025

Voir sur GitHubGuide contributeur
 (4 commentaires) (1 réaction) (0 personne assignée)CSS (2 088 forks)batch import
designhelp wantedinvestigate

Métriques du dépôt

Stars
 (5 330 étoiles)
Métriques de merge PR
 (Merge moyen 13j 7h) (43 PRs mergées en 30 j)

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

Direction de recherche
Étudiez la structure actuelle du site pour comprendre comment les pages sont rendues. Examinez Docusaurus et Astro Starlight pour des idées d'implémentation de table des matières. Consultez l'issue connexe #1759 pour le contexte. Analysez les modèles de mise en page existants dans le dépôt pour déterminer où ajouter les éléments DOM de la table des matières et comment les styliser.
Stack technique
javascripthtmlcssnodejs
Domaine
documentationfrontend
Type d'issue
Fonctionnalité
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.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
HTMLCSSstatic site generator basics
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70