docsifyjs/docsify

Feature request: TOC (Table Of Contents) on the right side

Open

#1,908 建立於 2022年10月24日

在 GitHub 查看
 (6 留言) (2 反應) (0 負責人)JavaScript (26,454 star) (5,630 fork)batch import
good first Issue

描述

Feature request

What problem does this feature solve?

Include a TOC (Table of Contents) section on the right side.

What does the proposed API look like?

How should this be implemented in your opinion?

The Table of contents should be autogenerated and triggered with a flag, similar to how the navigation or sidebars work. It would contain a separate file toc.md for example that would be used for styling and supplemental configuration.

It would look and work similar to how it's implemented currently for the android documentation: https://developer.android.com/games/develop/overview

Are you willing to work on this yourself?

No

貢獻者指南

技術棧
javascriptcsshtml
領域
documentation
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-2 days
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
mostly clear
前置要求
JavaScriptCSSDocsify plugin API
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
30
研究方向
Explore how Docsify generates sidebar navigation and plugins. Look at existing plugins for reference. The TOC should be auto generated from headings, similar to the sidebar. Implement a new plugin that adds a TOC on the right side, configurable via a flag. Reference the Android documentation example for styling and behavior. Start by understanding the plugin API and the markdown rendering process in src/.
Feature request: TOC (Table Of Contents) on the right side · docsifyjs/docsify#1908 | Good First Issue