-
Notifications
You must be signed in to change notification settings - Fork 201
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
Ability to configure the depth of a page context menu #598
Comments
Thanks for the feature request. Related to #440 This is a feature we have been contemplating for a while. I find your scenario of wanting to restrict to only H2 headings more valuable than enabling H4+ to be added to the table of contents. If/when we implement this functionality, we would allow the heading depth to be fully configurable. |
This new This feature is a Retype Pro only feature. New options include the Table of Contents The The SamplesProject toc:
label: On this page # default from .resx, "Contents" for EN
depth: 2 # default is 2-3 Page
Configuring the Acceptable values for
Hope this helps. |
Special thanks to @patricklafrance for sponsoring this feature development. |
Thank you very much! |
Hi @patricklafrance, is the new |
@geoffreymcgill 💯 using it for multiple pages and I love it 🙏🏻 |
@geoffreymcgill I noticed that if a default page ( For example, my
For the following pages structure:
Without any additional configuration, only If I configure the
Then the My expectation would be for the Thank you, Patrick |
Yes, but we are reviewing this. There are some page settings, such as Thanks for letting us know about this scenario. |
I might be going a bit too far and maybe it's more of a documentation architecture issue than a Retype issue but for some of my pages, I would like to be able to control if a specific header should be included or not in the ToC. Let me you know what you think! |
Can you elaborate on this statement? In your original scenario, you can set |
Sorry, I wasn't clear, I switched to a completely different scenario. Let's say there is another "custom-config.md" page that has been added to the previous pages structure:
This
For the Again, maybe I am going to far and this is my documentation information architecture that should be revisited. Still I am wondering what you think about this scenario? Thank you, Patrick |
Follow up to my previous comment. instead of excluding specific headers, including only specific headers in addition to the ones that are included by default with the |
I don't have a super strong opinion on this one, although my bias is to not include this functionality. I'm not seeing an advantage with excluding specific headings from the ToC. You are kinda messing unnecessarily with the consistency of the user-experience. We do have an internal open feature request to add support for applying a We could include
Let me know what you think. |
The reason I am adding those headers that I would like to exclude is strictly to get an # anchor link to facilitate sharing a link to a direct section of the documentation. |
For some pages, I would like to restrict the depth of a page context menu to h2 only. That would be useful if it was configurable with a page options.
The text was updated successfully, but these errors were encountered: