docsifyjs / docsifyjs/docsify

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

Open
#1,908 6 comments 2 reactions 0 assignees View on GitHub
good first Issue
Dominant language
JavaScript
Stars
31.5k
Forks
5.8k
Avg merge
9d 8h
Merged PRs (30d)
2

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

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.