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

Collapsus - The Collapsible Menu #1084

Closed
clearwaterstream opened this issue Nov 2, 2018 · 7 comments
Closed

Collapsus - The Collapsible Menu #1084

clearwaterstream opened this issue Nov 2, 2018 · 7 comments
Labels
feature This is not a bug or issue with Docusausus, per se. It is a feature request for the future. good first issue If you are just getting started with Docusaurus, this issue should be a good place to begin.

Comments

@clearwaterstream
Copy link

clearwaterstream commented Nov 2, 2018

🚀 Feature

Collapsible menu . Sub-categories will get collapsed under the main categories. Examples: https://reactjs.org/docs/getting-started.html or https://docs.gitbook.com/getting-started

Have you read the Contributing Guidelines on issues?

Yes I have

Motivation

We have a sizable amount of content and having a large (expanded) menu would overwhelm a user upon visiting our documentation area. Those with weaker nerves may get spooked and run away from our site.

Pitch

We have an "enterprise" level product which comes with sizable documentation. I am sure we are not the only ones. I think having this feature would attract other companies who have similar documentation requirements. Let the Collapsus out!

Thanks!!

@clearwaterstream clearwaterstream changed the title Collapsible Menu Collapsus - The Collapsible Menu Nov 2, 2018
@eliyasbaby
Copy link

🚀 Feature

Collapsible menu . Sub-categories will get collapsed under the main categories. Examples: https://reactjs.org/docs/getting-started.html or https://docs.gitbook.com/getting-started

Have you read the Contributing Guidelines on issues?

Yes I have

Motivation

We have a sizable amount of content and having a large (expanded) menu would overwhelm a user upon visiting our documentation area. Those with weaker nerves may get spooked and run away from our site.

Pitch

We have an "enterprise" level product which comes with sizable documentation. I am sure we are not the only ones. I think having this feature would attract other companies who have similar documentation requirements. Let the Collapsus out!

Thanks!!

Yes.this is indeed.this would be an awesome feature.I also want to show a huge list of content in the side bar.without the expand collapse option the huge list would be ugly

@endiliey endiliey added feature This is not a bug or issue with Docusausus, per se. It is a feature request for the future. good first issue If you are just getting started with Docusaurus, this issue should be a good place to begin. labels Nov 7, 2018
@tsmrachel
Copy link
Contributor

@endiliey @yangshun

Are there any plans to consider using React to add interactivity? Or should this be worked on using script injection?

#582 (comment)

Docusaurus uses React mainly to render the components statically into HTML on the server, so your code wouldn't work. There's no React library being sent to the client to hydrate the markup and add interactivity.

@endiliey
Copy link
Contributor

@tsmrachel that's our plan for Docusaurus v2

You can read on #789 or https://docusaurus.io/blog/2018/09/11/Towards-Docusaurus-2

Instead of pure static HTML, during build time we will create a server-rendered version of the app and render the corresponding HTML. A Docusaurus site will be essentially an isomorphic/universal application. This approach is heavily inspired by Gatsby.

tsmrachel added a commit to tsmrachel/Docusaurus that referenced this issue Nov 25, 2018
@markerikson
Copy link

I could see this being useful for Redux as well.

@giddev
Copy link

giddev commented Dec 17, 2018

I would prefer a multiple level treeview structure as implemeted with readthedocs than just a single or 2 level collapsable menu as give in the examples given by @clearwaterstream
Example:
https://sphinx-rtd-theme.readthedocs.io/en/latest/demo/structure.html#document-subsubsection

yangshun pushed a commit that referenced this issue Jan 23, 2019
* feat : #1084 Collapsus - The Collapsible Menu

* updated docs

* fixed prettier

* fix for category not auto-expanding upon navigating to a subcategory under it

* as requested by endiliey. Do not merge this commit.

* Update api-site-config.md

* Update guides-navigation.md

* Update SideNav.js

* Update main.css

* Update SideNav.js

* Delete subcategory1.md

* Delete subcategory2.md

* Update sidebars.json
@yangshun
Copy link
Contributor

This has been released in 1.7.1.

@clearwaterstream
Copy link
Author

Awesome, much thanks!!!

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. good first issue If you are just getting started with Docusaurus, this issue should be a good place to begin.
Projects
None yet
Development

No branches or pull requests

7 participants