-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Documentation for new includes directory
- Loading branch information
Showing
4 changed files
with
51 additions
and
35 deletions.
There are no files selected for viewing
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
A directory named `includes` exists under the application data directory where local [include | ||
templates][configdirective] may be placed. Any relative paths to include templates will start at | ||
this directory. | ||
|
||
For example, if I have the following include directive in a configuration file named `foo.yml`: | ||
|
||
```yml | ||
include: | ||
- config: bar/reusable.yml | ||
``` | ||
The expected file structure of my `includes` directory would be visualized as follows: | ||
|
||
```txt | ||
. | ||
├── configs/ | ||
│ └── foo.yml | ||
└── includes/ | ||
└── bar/ | ||
└── reusable.yml | ||
``` | ||
|
||
For more information about include templates, see the respective [behaviors page][include]. | ||
|
||
:::caution | ||
|
||
Configuration files (non-includes) should *not* be placed here; use the [`configs`][configsdir] | ||
directory for those. | ||
|
||
::: | ||
|
||
[include]: /yaml/config-reference/include.md | ||
[configdirective]: /yaml/config-reference/include.md#config | ||
[configsdir]: /file-structure.md#config-directory |
This file contains 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
This file contains 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
This file contains 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