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

Show more levels in the documentation page table of contents #99

Closed
schontz opened this issue Sep 9, 2021 · 3 comments · Fixed by #121
Closed

Show more levels in the documentation page table of contents #99

schontz opened this issue Sep 9, 2021 · 3 comments · Fixed by #121
Labels
area:docs Related to rendering the documentation ✨ enhancement New feature or request upstream Blocked by an upstream bug

Comments

@schontz
Copy link

schontz commented Sep 9, 2021

I couldn't find a feedback link on the new docs...

The table of contents links in the new docs leave much to be desired. A quick comparison:

Old docs:

image

New docs:

image

As you can see, the new docs omit all the actual events, properties, and methods. There is no way to see what is available without scrolling through pages and pages of content. And since the headings and content run together, it is quite hard to scan the page and determine what is available.

@MarshallOfSound MarshallOfSound transferred this issue from electron/electron Sep 9, 2021
@erickzhao erickzhao added the ✨ enhancement New feature or request label Sep 9, 2021
@erickzhao
Copy link
Member

erickzhao commented Sep 9, 2021

Hey @schontz, thanks for the report. We've moved it over to this repo.

I don't think Docusaurus has the ability to do this right now, as it only supports TOC for h2 and h3. There's an open feature request here: facebook/docusaurus#2700

This is definitely a pain point and I'll add it to the backlog, though. :)

@erickzhao erickzhao added upstream Blocked by an upstream bug area:docs Related to rendering the documentation labels Sep 9, 2021
@erickzhao erickzhao changed the title New docs feedback: show more headings in table of contents Show more headings in table of contents Sep 14, 2021
@erickzhao erickzhao changed the title Show more headings in table of contents Show more levels in the documentation page table of contents Sep 14, 2021
@erickzhao
Copy link
Member

I've opened facebook/docusaurus#5578 to amend this :)

@erickzhao
Copy link
Member

The upstream PR has been merged. We'll be picking up the additional configuration setting with Docusaurus 2.0.0-beta7

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:docs Related to rendering the documentation ✨ enhancement New feature or request upstream Blocked by an upstream bug
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants