-
Notifications
You must be signed in to change notification settings - Fork 2k
Formalize patching of book.js #2924
Copy link
Copy link
Open
Labels
bugSomething isn't workingSomething isn't workinggood first issueGood for newcomersGood for newcomers
Description
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:
- Store the modifications as a set of patches.
- Check that
theme/book.jsis truly equal to the originalbook.jsfile plus the applied patches in a GitHub action. - Some script which can update our
mdbookversion by updating thebook.jsfile.
I'm probably missing some steps here! 😄
Cc @djmitche, @gribozavr.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
bugSomething isn't workingSomething isn't workinggood first issueGood for newcomersGood for newcomers