docsifyjs/docsify

Feature request: TOC (Table Of Contents) on the right side

Open

#1 908 ouverte le 24 oct. 2022

Voir sur GitHub
 (6 commentaires) (2 réactions) (0 assignés)JavaScript (5 630 forks)batch import
good first Issue

Métriques du dépôt

Stars
 (26 454 stars)
Métriques de merge PR
 (Merge moyen 18j 16h) (9 PRs mergées en 30 j)

Description

Feature request

What problem does this feature solve?

Include a TOC (Table of Contents) section on the right side.

What does the proposed API look like?

How should this be implemented in your opinion?

The Table of contents should be autogenerated and triggered with a flag, similar to how the navigation or sidebars work. It would contain a separate file toc.md for example that would be used for styling and supplemental configuration.

It would look and work similar to how it's implemented currently for the android documentation: https://developer.android.com/games/develop/overview

Are you willing to work on this yourself?

No

Guide contributeur

Direction de recherche
Explorez comment Docsify génère la navigation de la barre latérale et les plugins. Consultez les plugins existants comme référence. La table des matières doit être générée automatiquement à partir des titres, de manière similaire à la barre latérale. Implémentez un nouveau plugin qui ajoute une table des matières sur le côté droit, configurable via un indicateur. Référez vous à l'exemple de la documentation Android pour le style et le comportement. Commencez par comprendre l'API des plugins et le processus de rendu Markdown dans src/.
Stack technique
javascriptcsshtml
Domaine
documentation
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.
1-2 jours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Ancienne
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Plutôt claire
Prérequis
JavaScriptCSSDocsify plugin API
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
30