dan
/
jekyll
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add language and examples to describe how to use the configuration options. (#8249) 

Merge pull request 8249
This commit is contained in:
jaybe@jekyll 2020-06-13 01:59:21 -05:00 committed by GitHub
parent a7e74122f3
commit 426e050b32
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/_docs/configuration/liquid.md
View File

@ -9,6 +9,13 @@ options are
- `warn` --- Output a warning on the console for each error. - `warn` --- Output a warning on the console for each error.
- `strict` --- Output an error message and stop the build. - `strict` --- Output an error message and stop the build.
Within _config.yml, this could be configured as follows:
```yaml
liquid:
error_mode: warn
```
You can also configure Liquid's renderer to catch non-assigned variables and You can also configure Liquid's renderer to catch non-assigned variables and
non-existing filters by setting `strict_variables` and / or `strict_filters` non-existing filters by setting `strict_variables` and / or `strict_filters`
to `true` respectively. {% include docs_version_badge.html version="3.8.0" %} to `true` respectively. {% include docs_version_badge.html version="3.8.0" %}
@ -16,3 +23,14 @@ to `true` respectively. {% include docs_version_badge.html version="3.8.0" %}
Do note that while `error_mode` configures Liquid's parser, the `strict_variables` Do note that while `error_mode` configures Liquid's parser, the `strict_variables`
and `strict_filters` options configure Liquid's renderer and are consequently, and `strict_filters` options configure Liquid's renderer and are consequently,
mutually exclusive. mutually exclusive.
An example of setting these variables within _config.yml is as follows:
```yaml
liquid:
error_mode strict
strict_variables: true
strict_filters: true
```
Configuring as described above will stop a build/serve from happening and instead call out the offending error and halt. This is helpful when desiring to catch liquid-related issues by stopping the build or serve process and forcing you to deal with it.