Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Included markdown files are not update with mdbook serve #2536

Open
konstin opened this issue Jan 28, 2025 · 0 comments
Open

Included markdown files are not update with mdbook serve #2536

konstin opened this issue Jan 28, 2025 · 0 comments
Labels
C-bug Category: A bug, incorrect or unintended behavior

Comments

@konstin
Copy link

konstin commented Jan 28, 2025

Problem

Files included with {{#include path/to/file}} are not updated with mdbook serve, and it seems there is no option to manually add files to be watched.

In our (maturin), we include the readme as introduction page in the guide to avoid repeating the content from the readme.

Steps

  1. git clone https://github.com/konstin/mkbook-watch-reproducer
  2. mdbook serve guide and open the page in the browser
  3. Edit installation.md. The changes are updated in the browser.
  4. Edit Readme.md. The changes are not updated in the browser! You need to run mdbook build guide to rebuild them.

Possible Solution(s)

mdbook should watch included files, too, or add an option to manually include them. I tried extra-watch-dirs with .., with an absolute path and with the path to the directory, but to no avail.

Notes

No response

Version

0.4.43 and dff5ac64e59c9c8df7327eba22561770fd65e958
@konstin konstin added the C-bug Category: A bug, incorrect or unintended behavior label Jan 28, 2025
konstin added a commit to PyO3/maturin that referenced this issue Jan 28, 2025
I found an mdbook bug (rust-lang/mdBook#2536). The update doesn't fix that, but it bumps us to the latest version.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-bug Category: A bug, incorrect or unintended behavior
Projects
None yet
Development

No branches or pull requests

1 participant