docsifyjs/docsify

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

Open

#1 249 ouverte le 26 juin 2020

Voir sur GitHub
 (0 commentaires) (4 réactions) (0 assignés)JavaScript (5 630 forks)batch import
enhancementgood first Issuepr welcomesemver-minor

Métriques du dépôt

Stars
 (26 454 stars)
Métriques de merge PR
 (Merge moyen 18j 16h) (9 PRs mergées en 30 j)

Description

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
}

Guide contributeur

Direction de recherche
Examinez le code source de Docsify pour localiser la gestion de l'option de configuration `onlyCover`, probablement dans les fichiers JavaScript principaux. Identifiez où la logique de rendu de la page de couverture et du menu est contrôlée. Ajoutez une nouvelle option `onlyCoverShowMenu` qui, lorsqu'elle est `true`, affiche le menu même lorsque `onlyCover` est true. Assurez vous que la valeur par défaut est `false` pour maintenir la rétrocompatibilité.
Stack technique
javascript
Domaine
frontend
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Ancienne
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Familiarity with Docsify configurationJavaScript basics
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85