google/comprehensive-rust

Formalize patching of `book.js`

Open

#2,924 创建于 2025年9月23日

在 GitHub 查看
 (4 评论) (0 反应) (0 负责人)Rust (32,954 star) (2,009 fork)batch import
buggood first issue

描述

Inspired by #2571 and other similar changes I made myself, we need to come up with a proper system for maintaining our customizations to theme/book.js. That is, we need to store our modifications as patches or something very similar. Right now, our customizations are direct edits to the file.

The problem is that mdbook is somewhat coupled to it's theme: when we update mdbook to a new version, we run the risk of messing up the rendering if we don't update our (partial!) copy of the default theme.

I'm imagining a system where we:

  1. Store the modifications as a set of patches.
  2. Check that theme/book.js is truly equal to the original book.js file plus the applied patches in a GitHub action.
  3. Some script which can update our mdbook version by updating the book.js file.

I'm probably missing some steps here! 😄

Cc @djmitche, @gribozavr.

贡献者指南

技术栈
javascriptrust
领域
toolingdeveloper experience
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-2 days
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
fresh
清晰度议题是否清楚说明期望改动、验收标准和下一步。
needs investigation
前置要求
GitJavaScriptmdbook basics
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
30
研究方向
This issue proposes formalizing a patching system for customizations to mdbook's theme/book.js. First, research existing patching tools and workflows (e.g., patch files, git submodules, or tools like quilt). Then, design a system to verify that book.js matches the original plus patches, likely via a GitHub Action. Consider how to automate updating book.js when mdbook is updated. Files involved: theme/book.js, potentially a new patches/ directory and CI configuration.