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

Flag: html in header #144

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

Flag: html in header #144

steveklabnik opened this issue Aug 10, 2017 · 5 comments
Labels
backend E-Medium help wanted question

Comments

@steveklabnik
Copy link
Owner

This issue is part of #125

--html-in-header: include more HTML in

Using this flag looks like this:

$ rustdoc src/lib.rs --html-in-header header.html
$ rustdoc README.md --html-in-header header.html

This flag takes a list of files, and inserts them into the <head> section of
the rendered documentation.

Should we keep this flag or not?
@steveklabnik
Copy link
Owner Author

I think we should support this use-case, but I'm not sure that this flag is the right way to do it.

@mgattozzi
Copy link
Contributor

A lot of these seem to be ways to extend or change how rustdoc looks. Instead of a feature flag maybe we can just read from a directory that will overide how the docs look for it.

@steveklabnik
Copy link
Owner Author

Yeah, I'd be down for that, or maybe something like how mdbook does it

http://azerupi.github.io/mdBook/format/theme/theme.html

@mgattozzi
Copy link
Contributor

That seems like a good idea. Just having a theme directory to automatically theme it all seems solid.

@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.
Assignees
No one assigned
Labels
backend E-Medium help wanted question
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@steveklabnik @mgattozzi