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

[request] increase depth for TOC in the right side of references pages #2444

Closed
1 task
arkhaiel opened this issue Jul 21, 2024 · 1 comment · Fixed by #2473
Closed
1 task

[request] increase depth for TOC in the right side of references pages #2444

arkhaiel opened this issue Jul 21, 2024 · 1 comment · Fixed by #2473
Labels
enhancement Does it add or improve content?
Milestone

Comments

@arkhaiel
Copy link

arkhaiel commented Jul 21, 2024

Question you want answered

Can you increase depth of titles in TOC for references pages ?

Where did you look for an answer?

I just spent like 15' exploring the source of this repo, the Astro docs, and couldn't find any information related to TOC depth.

Page URL

v2 Store Reference

Additional context

Let's take this page : https://v2.tauri.app/reference/javascript/store/#store

The class store has many methods, the methods are not shown in the TOC on the right side of the screen, and it's difficult to get quickly what we would need.

I'm definitely not used to Astro and I can't find where you generate the TOC so I'm afraid I won't be able to help, but I'm new to Tauri and I certainely will spent A LOT of time reading the API references, and this small tweak would surely lead to better comfort.

Thanks a lot !

Are you willing to work on this yourself?

  • I want to work on this myself
@arkhaiel arkhaiel added discuss Does this require further discussion before it's dealt with? enhancement Does it add or improve content? labels Jul 21, 2024
@github-project-automation github-project-automation bot moved this to 🪵 Backlog in Documentation Jul 21, 2024
@simonhyll
Copy link
Contributor

We can certainly do that, not sure which depth we'd wanna do though 🤔
For reference it's a simple frontmatter updater, e.g. tableOfContents.maxHeadingLevel: 6

@simonhyll simonhyll added this to the Version 2.x milestone Jul 24, 2024
@simonhyll simonhyll removed the discuss Does this require further discussion before it's dealt with? label Jul 24, 2024
@simonhyll simonhyll moved this from 🪵 Backlog to 💪 Ready in Documentation Jul 24, 2024
@github-project-automation github-project-automation bot moved this from 💪 Ready to ✅ Done in Documentation Jul 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Does it add or improve content?
Projects
Status: ✅ Done
Development

Successfully merging a pull request may close this issue.

2 participants