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

Prevent mdBook from recursively copying all files in src to dest #2246

Open
spmadden opened this issue Nov 24, 2023 · 1 comment · May be fixed by #2247
Open

Prevent mdBook from recursively copying all files in src to dest #2246

spmadden opened this issue Nov 24, 2023 · 1 comment · May be fixed by #2247
Labels
C-enhancement Category: Enhancement or feature request

Comments

@spmadden
Copy link

Problem

In a large multi-module mono-repository, it doesn't always make sense to have your book documentation locked into a single folder/book module. Each module should be able to contribute it's own set of markdown files to the common "book".

I can get 90% of the way there by putting a book.toml and SUMMARY.md file at the root of the repository, and setting src = '.' in book.toml. However, this then copies the entire repository to the output/dest directory, which is obviously inadvisable.

Proposed Solution

Until we get some of the other PRs closed with better relative & absolute links support (which will solve my problem a better way), recommend adding a flag to disable the recursive file copy in the HTML renderer at https:/rust-lang/mdBook/blob/master/src/renderer/html_handlebars/hbs_renderer.rs#L631 , which will give me the final behavior I'm looking for.

Notes

No response

@sanmai-NL
Copy link

sanmai-NL commented Mar 1, 2024

See #1187 and #1156.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-enhancement Category: Enhancement or feature request
Projects
None yet
2 participants