rust-lang / rust-lang/mdBook

Support explicit renderer order

Open
#2,803 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Problem

Similar to how preprocessors allow specifying the order (added in https://github.com/rust-lang/mdBook/pull/1607), it might be a good idea to also support this for renderers. Apparently, from https://github.com/rust-lang/mdBook/pull/2801, it was noted that some renderers depend on a particular order. Depending on the alphabetical order isn't probably the best way to make that dependency.

Proposed Solution

Support the same before/after keys from preprocessors in the output table.

Notes
mdbook v0.4.52

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 comparing the renderer output table handling with the existing preprocessor ordering behavior described in the issue. The work is done when renderers accept the same before/after keys and their order no longer depends on alphabetical sorting.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
cli
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.