Skip to content

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

Description

@adriandev78

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

Activity

  1. changed the title [-]TOC (Table Of Contents) on the right side[/-] [+]Feature request: TOC (Table Of Contents) on the right side[/+] on Oct 24, 2022
  2. ciprianqoob commented on Oct 25, 2022

    @ciprianqoob

    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.

  3. sy-records commented on Oct 26, 2022

    @sy-records
    Member

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

  4. akankshaoops commented on Oct 29, 2022

    @akankshaoops

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

  5. sy-records commented on Oct 30, 2022

    @sy-records
    Member

    Hi @akankshaoops Do you want to implement this feature?

  6. akankshaoops commented on Oct 30, 2022

    @akankshaoops

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

  7. dror-weiss commented on Apr 12, 2023

    @dror-weiss

    @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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions