docsifyjs/docsify

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

Open

#1,249 opened on Jun 26, 2020

View on GitHub
 (0 comments) (4 reactions) (0 assignees)JavaScript (26,454 stars) (5,630 forks)batch import
enhancementgood first Issuepr welcomesemver-minor

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
}

Contributor guide

Tech stack
javascript
Domain
frontend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Familiarity with Docsify configurationJavaScript basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
Look into the Docsify source code to locate the handling of the `onlyCover` configuration option, likely in the core JavaScript files. Identify where the cover page and menu rendering logic is controlled. Add a new `onlyCoverShowMenu` option that, when `true`, displays the menu even when `onlyCover` is true. Ensure it defaults to `false` to maintain backward compatibility.