Skip to content

fix: add warning about file path restrictions #151

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.

Sign up for GitHub

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

Merged
squidfunk merged 1 commit into from
Jul 18, 2026
Merged

fix: add warning about file path restrictions #151

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/setup/extensions/macros.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,15 @@ The Macros extension, included with Zensical, enables [Jinja2] templating in Mar

[mkdocstrings]: https://mkdocstrings.github.io

!!! warning "Keep files in project folder"

Zensical watches files to able to re-build the project when they change.
This includes Python files containing macros and YAML files included
with `include_yml`. Since Zensical's security policy does not allow paths
outside the project folder, make sure that any files used are located
inside it. This includes modules installed in virtual environments,
which must also be created within the project folder.

The following additional configuration options are supported:

#### `module_name`
Expand Down