docsifyjs/docsify

when onlyCover is true, also provide an option to show the menu.

Open

#1249 aperta il 26 giu 2020

Vedi su GitHub
 (0 commenti) (4 reazioni) (0 assegnatari)JavaScript (5630 fork)batch import
enhancementgood first Issuepr welcomesemver-minor

Metriche repository

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

Descrizione

Continuing from https://github.com/docsifyjs/docsify/issues/1173#event-3485443350

Feature request

When only onlyCover is true, it would be great to have an option to show the menu (and of course the menu should not be empty).

What problem does this feature solve?

Allows people to skip to content faster.

What does the proposed API look like?

window.$docsify = {
  onlyCover: true,
  onlyCoverShowMenu: true, // false by default
}

Guida contributor

Direzione di ricerca
Esamina il codice sorgente di Docsify per individuare la gestione dell'opzione di configurazione `onlyCover`, probabilmente nei file JavaScript core. Identifica dove viene controllata la logica di rendering della pagina di copertina e del menu. Aggiungi una nuova opzione `onlyCoverShowMenu` che, quando `true`, visualizzi il menu anche quando `onlyCover` è true. Assicurati che il valore predefinito sia `false` per mantenere la compatibilità con le versioni precedenti.
Tech stack
javascript
Dominio
frontend
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Datata
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Familiarity with Docsify configurationJavaScript basics
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85