docsify icon indicating copy to clipboard operation
docsify copied to clipboard

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

Open adriandev78 opened this issue 3 years ago • 6 comments

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

adriandev78 avatar Oct 24 '22 10:10 adriandev78

This would be a great feature to have with docsify. This seems to be the standard in the tech documentations and all big companies use a right TOC for their tech documentations.

ciprianqoob avatar Oct 25 '22 12:10 ciprianqoob

Before the official support, you can try this third-party plugin https://github.com/mrpotatoes/docsify-toc

sy-records avatar Oct 26 '22 05:10 sy-records

I'd like to work on this in case no one has been assigned already.

akankshaoops avatar Oct 29 '22 12:10 akankshaoops

Hi @akankshaoops Do you want to implement this feature?

sy-records avatar Oct 30 '22 05:10 sy-records

Hi @sy-records, yes, I'd like to work on this feature.

akankshaoops avatar Oct 30 '22 14:10 akankshaoops

@sy-records , I would also appreciate official support because I think it's a must-have feature. 3rd party plugins don't have reliable ignore-specific headers support.

dror-weiss avatar Apr 12 '23 09:04 dror-weiss