rust-lang / rust-lang/mdBook

Allow combining themes (output.html.theme and theme/)

Open
#3,015 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

C-enhancement
Dominant language
Rust
Stars
22.2k
Forks
1.9k
PR merge metrics
PR metrics pending

Description

Problem

I'm trying mdBook 0.5.2 with output.html.theme = "third_party/theme" and a theme/ directory and the latter is completely ignored. The latter contains only the favicon.

Proposed Solution

Allow theme/ to override output.html.theme specified theme.

Allow head.hbs combination as well.

Notes
  • allow head.hbs combination

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the theme-loading entry point for output.html.theme and theme/; reproduce the issue with the shown mdBook 0.5.2 configuration and a favicon-only theme. Check how head.hbs is handled, then verify that files in theme/ override the configured theme and that head.hbs combination behaves as specified.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.