Skip to content

Commit a072df8

Browse files
authored
Merge pull request #1392 from mcanouil/docs/tip-include-path
docs: add tip about absolute path in include shortcode important callout
2 parents 07efbfe + 199007c commit a072df8

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

docs/authoring/includes.qmd

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,9 @@ To include a file, add the `{{{< include >}}}` shortcode at the location in your
1414

1515
::: callout-important
1616

17-
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.
17+
Include shortcodes are equivalent to copying and pasting the text from the included file into the main file.
18+
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.
19+
Use absolute (to the project root) paths for links, images, or other includes, in included files to ensure they resolve correctly, *e.g.*, `[A Figure Reused](/path/to/image.png)` or `{{< include /path/to/_file.qmd >}}`.
1820

1921
It also means that if the included file has a metadata block, that block will take effect in all included files. In most cases, having metadata blocks in an included file will cause unexpected behavior.
2022

@@ -110,4 +112,4 @@ code span.in {
110112
font-style: normal;
111113
}
112114
</style>
113-
```
115+
```

0 commit comments

Comments
 (0)