rust-lang / rust-lang/mdBook

Consider a way to make the extension configs extendable

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

Nobody has claimed this yet.

A-Configuration
Dominant language
Rust
Stars
22.2k
Forks
1.9k
PR merge metrics
PR metrics pending

Description

Currently mdbook allows preprocessors and renderers to define their own config settings in their corresponding configuration table. For example, mdbook-linkcheck has a bunch of settings. However, these settings share the same namespace with mdbook itself which has settings like command, optional, renderers, before, and after. Each time mdbook adds its own configuration setting, there is a risk that it can conflict with existing extensions.

I think it would be good to consider a different structure to allow mdbook to add new settings without potentially interfering with existing extensions. This would allow new settings to be added in a backwards-compatible way.

I don't really know what that would look like. It could be some different sub-table like output.name.settings?

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 reading how mdBook parses configuration tables for preprocessors and renderers, then compare the built-in keys with extension-defined settings such as those in mdBook-linkcheck. Done means proposing and documenting a configuration structure that avoids namespace conflicts while preserving a clear path for backwards-compatible additions.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.