Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Table Of Contents: Allow user to collapse Table of Contents #10272

Open
2 tasks done
foxtrotravi opened this issue Jul 6, 2024 · 0 comments
Open
2 tasks done

Table Of Contents: Allow user to collapse Table of Contents #10272

foxtrotravi opened this issue Jul 6, 2024 · 0 comments
Labels
feature This is not a bug or issue with Docusausus, per se. It is a feature request for the future.

Comments

@foxtrotravi
Copy link

Have you read the Contributing Guidelines on issues?

Description

Here is something similar implemented in Mkdocs: squidfunk/mkdocs-material#3428

Currently, we have collapsable sidebar but there is no option to collapse the "Table Of Contents".

Has this been requested on Canny?

https://docusaurus.io/feature-requests/p/can-the-table-of-contents-be-collapsible

Motivation

The motivation of this proposal is to allow users to enter full screen mode / focus mode for reading docs and not get distracted by sidebar / table of contents.

API design

squidfunk/mkdocs-material#3428 (comment)

Have you tried building it?

No, not yet but I will try to swizzle the component for "Table Of Contents". If that works, I will add a comment here or raise a pull request myself.

Self-service

  • I'd be willing to contribute this feature to Docusaurus myself.
@foxtrotravi foxtrotravi added feature This is not a bug or issue with Docusausus, per se. It is a feature request for the future. status: needs triage This issue has not been triaged by maintainers labels Jul 6, 2024
@slorber slorber removed the status: needs triage This issue has not been triaged by maintainers label Jul 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature This is not a bug or issue with Docusausus, per se. It is a feature request for the future.
Projects
None yet
Development

No branches or pull requests

2 participants