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

Support 2 levels of headings in Table of Contents #80

Open
pmatulis opened this issue May 31, 2017 · 2 comments
Open

Support 2 levels of headings in Table of Contents #80

pmatulis opened this issue May 31, 2017 · 2 comments

Comments

@pmatulis
Copy link

This issue was forked from #61.

Only including 2nd-level links in the TOC is very limiting, especially for a page such as the release notes. Yet allowing for 3rd-level links brings us back to the issue of duplicate text headers not becoming links. I feel trapped in a small box. Do you have a suggestion as to how the release notes can be displayed? Users complain of not having a decent TOC for such a document. They want to see quickly what new features have appeared and this can be accomplished, in principle, by a TOC, especially since this is what was available in the old MAAS docs.

@nottrobin nottrobin changed the title TOC is too limiting Support 2 levels of headings in Table of Contents Sep 14, 2017
@nottrobin
Copy link
Contributor

I think this is a reasonable argument for including one more level of headings in the TOC. But I'm not sure it should be the default option, and we will also need to solve the duplicate heading issue.

@pmatulis
Copy link
Author

Can we not allow the source file (.md) to select a second-level TOC?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants