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

Ability to add content to help without showing in table of contents #234

Open
rmglennon opened this issue Nov 18, 2016 · 1 comment
Open

Comments

@rmglennon
Copy link
Member

I don't see a way in MkDocs to set the visibility property for a topic in the table of contents. It seems like including the md file is the only way to include it with the build. Or maybe this is something we can control?

Having a visible-in-toc = false option (or something like that) would allow the help to be published all together and get a stable URL for things like links from blog posts. As it is, we are sometimes held up with announcements or documentation reviews because the documentation is not in its final location (for example, sometimes precog doesn't work nicely with new and existing content and can't find topics).

Normally, having content not be discoverable from the table of contents is a really bad user experience paradigm, but works nicely in "soft launch" situations. So, this should be used with great care.

cc @drewda

@rmglennon
Copy link
Member Author

See also mkdocs/mkdocs#699 for lengthy discussion on this with some workarounds

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

No branches or pull requests

1 participant