docsifyjs/docsify

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

Open

#1,249 opened on 2020年6月26日

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

説明

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
}

コントリビューターガイド

技術スタック
javascript
領域
frontend
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
stale
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
Familiarity with Docsify configurationJavaScript basics
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
85
調査方針
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.
when onlyCover is true, also provide an option to show the menu. · docsifyjs/docsify#1249 | Good First Issue