docsifyjs/docsify

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

Offen

#1.908 geöffnet am 24.10.2022

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

Repository-Metriken

Stars
 (26.454 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 10T 13h) (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 die aktuelle Seitenleiste und Navigation in docsify implementiert sind. Entwerfe dann einen ähnlichen Mechanismus für ein rechtsseitiges Inhaltsverzeichnis (TOC), das automatisch aus Überschrift Tags generiert wird. Sieh dir die Android Entwicklerdokumentation (https://developer.android.com/games/develop/overview) für Layout Inspiration an. Das TOC sollte durch ein Flag ausgelöst werden und eine toc.md Datei für zusätzliche Konfiguration unterstützen.
Tech Stack
javascript
Domain
frontend
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.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitJavaScriptMarkdown
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60