docs: add tip about absolute path in include shortcode important callout #1392
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Collaborator
|
I'd prefer if we didn't nest callouts. |
Contributor
Author
|
I noticed an issue and was filling it before reverting this^^ |
mcanouil
changed the title
cwickham
reviewed
Oct 22, 2024
docs/authoring/includes.qmd
Outdated
| Include shortcodes are equivalent to copying and pasting the text from the included file into the main file. This means that relative references (links, images, etc.) inside the included file resolve based on the directory of the main file not the included file. | ||
| Include shortcodes are equivalent to copying and pasting the text from the included file into the main file. | ||
| This means that relative references (links, images, etc.) inside the included file resolve based on the directory of the main file not the included file. | ||
| Use absolute (to the project root) paths for links and images in included files to ensure they resolve correctly, *e.g.*, `{{< include /path/to/file.qmd >}}`. |
Collaborator
There was a problem hiding this comment.
I don't understand the example. Shouldn't it be an example of a link or image, not an include?
Contributor
Author
There was a problem hiding this comment.
Actually, both were the cause of issues to users. I've added an image example as well.
Collaborator
There was a problem hiding this comment.
Do you mean when using {{< include >}} inside an included file? In which case, it might be clearer to inlcude that in the examples of references :
This means that relative references (links, images, other includes, etc.) inside the included file resolve based on the directory of the main file not the included file.
Use absolute (to the project root) paths for links, images or other includes, in included files to ensure they resolve correctly, *e.g.*, ...
Collaborator
|
/deploy-preview |
Contributor
|
🚀 Deployed on https://deploy-preview-1392.quarto.org |
Collaborator
|
Thanks @mcanouil ! |
Contributor
|
Successfully created backport PR for |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request adds a tip to the documentation about using absolute paths in the include shortcode. The tip explains that using absolute paths ensures that links and images in included files resolve correctly regardless of where the file is included via the shortcode.
Motivation: several users were bitten by this. The explicit tip might help avoid the issue.