docsifyjs/docsify

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

Open

#1,908 opened on Oct 24, 2022

View on GitHub
聽(6 comments)聽(2 reactions)聽(0 assignees)JavaScript聽(26,454 stars)聽(5,630 forks)batch import
good first Issue

Description

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

Contributor guide

Tech stack
javascriptcsshtml
Domain
documentation
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
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.
mostly clear
Prerequisites
JavaScriptCSSDocsify plugin API
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
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