steveklabnik/rustdoc

Flag: extend-css

Open

#148 opened on Aug 10, 2017

View on GitHub
 (4 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

-e/--extend-css: extend rustdoc's CSS

Using this flag looks like this:

$ rustdoc src/lib.rs -e extra.css
$ rustdoc src/lib.rs --extend-css extra.css

With this flag, the contents of the files you pass are included at the bottom of Rustdoc's theme.css file.

While this flag is stable, the contents of theme.css are not, so be careful! Updates may break your theme extensions.

Should we keep this flag or not?

Contributor guide

Research direction
Discuss the pros and cons of keeping the extend css flag. Consider stability of theme.css and maintenance burden.
Tech stack
rust
Domain
documentation
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
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
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90