Feature request: TOC (Table Of Contents) on the right side · docsifyjs/docsify#1908

(6 commenti) (2 reazioni) (0 assegnatari)JavaScript (5630 fork)batch import

good first Issue

Metriche repository

Star: (26.454 star)
Metriche merge PR: (Merge medio 18g 16h) (9 PR mergiate in 30 g)

Descrizione

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?

Guida contributor

Direzione di ricerca: Esplora come Docsify genera la navigazione nella barra laterale e i plugin. Guarda i plugin esistenti come riferimento. Il sommario dovrebbe essere generato automaticamente dai titoli, simile alla barra laterale. Implementa un nuovo plugin che aggiunge un sommario sul lato destro, configurabile tramite un flag. Fai riferimento all'esempio della documentazione Android per lo stile e il comportamento. Inizia comprendendo l'API dei plugin e il processo di rendering del markdown in src/.
Tech stack: javascriptcsshtml
Dominio: documentation
Tipo issue: Funzionalità
Difficoltà: 3
Tempo stimato: 1-2 giorni
Stato attività: Datata
Chiarezza: Abbastanza chiara
Prerequisiti: JavaScriptCSSDocsify plugin API
Adatta ai principianti: 30