Turn off TOC by default when wide theme is selected

[pettiross]

Because our primary scenario is helping authors create dashboards, we should make the TOC (in the right margin) opt-in instead of opt-out. When someone wants to write a longer report-style document, they could turn on the TOC.

[mbostock]

The TOC is useful for longer-style reports (documents, more like polished notebooks), and we also intend to have a theme: dashboards #60 which probably won’t be the default. Maybe we should have a more refined heuristic for enabling the TOC, based on the chosen theme? And it’s already the case that the TOC is off unless there are h2 headings. Do we expect h2 headings (and sections) to be used in dashboards?

[pettiross]

I like that idea, @mbostock, tying the TOC to the theme. That makes a bunch of sense to me, and I wasn't aware of #60. Thanks for pointing it out. Edited the title.

[Fil]

I'd be in favor of doing nothing, and keeping the two topics independent.

If you want a dashboard without a TOC, you have 3 possibilities:

• don't use H2 (nor H1) in the contents, or
• specify toc: false in front-matter, or
• specify toc: false in the config for a site-wide setting.

This only has to be documented as part of "toc", and the knowledge is then transferable to any theme.

[cinxmo]

I agree with @Fil on keeping the 2 topics independent. It would become confusing having to look at the source code/ document which themes have TOC enabled vs doesn't. We can definitely default toc: false globally instead of enabling it now though.

[Fil]

Closing as "not planned"; feel free to reopen if the consensus shifts.