Skip to content
This repository has been archived by the owner on May 20, 2020. It is now read-only.

Flag: markdown no TOC #147

Open
steveklabnik opened this issue Aug 10, 2017 · 2 comments
Open

Flag: markdown no TOC #147

steveklabnik opened this issue Aug 10, 2017 · 2 comments

Comments

@steveklabnik
Copy link
Owner

This issue is part of #125

--markdown-no-toc: don't generate a table of contents

Using this flag looks like this:

$ rustdoc README.md --markdown-no-toc

When generating documentation from a Markdown file, by default, rustdoc will
generate a table of contents. This flag supresses that, and no TOC will be
generated.


Should we keep this flag or not?

@steveklabnik
Copy link
Owner Author

We don't yet have any support for regular markdown files, and if so, I'm not sure what we'd do with TOCs. Dunno.

@steveklabnik
Copy link
Owner Author

We talked about this at the tools team meeting today and the intention is to figure out support for lightly customizing rustdoc's output as a first-class thing, but not necessarily via this low-level mechanism.

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

No branches or pull requests

1 participant