docsifyjs/docsify

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

Open

#1.249 geöffnet am 26. Juni 2020

Auf GitHub ansehen
 (0 Kommentare) (4 Reaktionen) (0 zugewiesene Personen)JavaScript (5.630 Forks)batch import
enhancementgood first Issuepr welcomesemver-minor

Repository-Metriken

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

Beschreibung

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
}

Contributor Guide

Research-Richtung
Untersuche den Docsify Quellcode, um die Verarbeitung der Konfigurationsoption `onlyCover` zu finden, wahrscheinlich in den Core JavaScript Dateien. Identifiziere, wo die Logik für das Rendern der Cover Seite und des Menüs gesteuert wird. Füge eine neue Option `onlyCoverShowMenu` hinzu, die, wenn sie `true` ist, das Menü auch dann anzeigt, wenn `onlyCover` true ist. Stelle sicher, dass der Standardwert `false` ist, um die Abwärtskompatibilität zu gewährleisten.
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.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
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.
Klar
Voraussetzungen
Familiarity with Docsify configurationJavaScript basics
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85