steveklabnik/rustdoc

Flag: html-*-content

Open

#145 opened on Aug 10, 2017

View on GitHub
 (2 comments) (0 reactions) (0 assignees) (22 forks)github user discovery
E-Mediumbackendhelp wantedquestion

Repository metrics

Stars
 (104 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

This issue is part of https://github.com/steveklabnik/rustdoc/issues/125

I'm lumping two into this issue:

--html-before-content: include more HTML before the content

Using this flag looks like this:

$ rustdoc src/lib.rs --html-before-content extra.html
$ rustdoc README.md --html-before-content extra.html

This flag takes a list of files, and inserts them inside the <body> tag but before the other content rustodc would normally produce in the rendered documentation.

--html-after-content: include more HTML after the content

Using this flag looks like this:

$ rustdoc src/lib.rs --html-after-content extra.html
$ rustdoc README.md --html-after-content extra.html

This flag takes a list of files, and inserts them before the </body> tag but after the other content rustodc would normally produce in the rendered documentation.

Should we keep this flag or not?

Contributor guide

Research direction
Evaluate the usage and community feedback on the ` html before content` and ` html after content` flags. Assess their necessity and potential deprecation in favor of alternatives like custom templates or plugins. Propose a decision with supporting evidence.
Tech stack
rust
Domain
documentation
Issue type
Research
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Rustrustdoc
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50