docsifyjs/docsify

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

Open

#1,249 建立於 2020年6月26日

在 GitHub 查看
 (0 留言) (4 反應) (0 負責人)JavaScript (26,454 star) (5,630 fork)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
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
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.