docsifyjs/docsify

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

Open

#1.908 geöffnet am 24. Okt. 2022

Auf GitHub ansehen
 (6 Kommentare) (2 Reaktionen) (0 zugewiesene Personen)JavaScript (5.630 Forks)batch import
good first Issue

Repository-Metriken

Stars
 (26.454 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 18T 16h) (9 gemergte PRs in 30 T)

Beschreibung

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

Contributor Guide

Research-Richtung
Untersuche, wie Docsify die Seitenleisten Navigation und Plugins generiert. Sieh dir vorhandene Plugins als Referenz an. Das Inhaltsverzeichnis sollte automatisch aus Überschriften generiert werden, ähnlich wie die Seitenleiste. Implementiere ein neues Plugin, das rechts ein Inhaltsverzeichnis hinzufügt, das über ein Flag konfigurierbar ist. Beziehe dich für Stil und Verhalten auf das Beispiel der Android Dokumentation. Beginne damit, die Plugin API und den Markdown Rendering Prozess in src/ zu verstehen.
Tech Stack
javascriptcsshtml
Domain
documentation
Issue Type
Funktion
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.
1-2 Tage
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Veraltet
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Meist klar
Voraussetzungen
JavaScriptCSSDocsify plugin API
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
30