Support before and after hooks on output/renderer configs

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

Nobody has claimed this yet.

Assessment

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

Research direction

Start by tracing how before and after fields are parsed and applied for preprocessor configurations, then compare that path with output and renderer configuration from book.toml. Confirm the intended ordering around the HTML renderer and add coverage showing that before and after hooks work for configured outputs.

Written by the indexing model from the issue text.

Description

C-enhancement
Problem

I have a custome renderer which I would like to have run AFTER the html renderer. This is possible with a preprocessor, but not supported for renderers.

Proposed Solution

I propose after and before fields be added as fields supported under all outputs configured in a book.toml. These are defined and behave in the same way as their counterparts on preprocessor configs, but apply to renderers instead.

Notes

No response

Dominant language
Rust
Stars
22.2k
Forks
1.9k
Avg merge
2d 21h
Merged PRs (30d)
12

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.

More from rust-lang/mdBook

All issues in rust-lang/mdBook

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.