Skip to content

Commit 6d3688e

Browse files
committed
Make a note about symlinks and snippets
1 parent c684985 commit 6d3688e

2 files changed

Lines changed: 6 additions & 0 deletions

File tree

‎docs/src/dictionary/en-custom.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,7 @@ Stienstra
109109
StripHTML
110110
Stylesheets
111111
SuperFences
112+
Symlinks
112113
TODO
113114
Takhteyev
114115
Tasklist

‎docs/src/markdown/extensions/snippets.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -238,6 +238,11 @@ we specified a snippet of `test.md` and we had a `base_path` of `#!py3 ["some/lo
238238
A specified snippet of `location/test.md` would not match. This is great if you have a one off file outside of your
239239
base directory, but you'd like to directly include it.
240240

241+
242+
> [!warning] Symlinks
243+
> Symlinks can be placed in the Snippets path and will be followed. If you do not want Snippets to follow Symlinks,
244+
> do not place them in the restricted path.
245+
241246
## URL Snippets
242247

243248
URLs, if `url_download` is enabled, can also be used as snippets. Instead of using a file, simply specify a URL in

0 commit comments

Comments
 (0)