Skip to content

Commit c5a72d5

Browse files
committed
docs: add note about non-schema front matter
Adds a note to the Markdown docs about non-schema front matter. Also adds a link to the settings file in GitHub to show the default values
1 parent 7783c5d commit c5a72d5

File tree

2 files changed

+7
-0
lines changed

2 files changed

+7
-0
lines changed

docs/content/configuration/settings.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,5 @@ The setting hierarchy is:
2020
See the `Settings` type for Blurry's available settings:
2121

2222
@python<blurry.settings.Settings>
23+
24+
The default values are visible at <https://github.com/blurry-dev/blurry/blob/main/blurry/settings.py>

docs/content/content/markdown.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,18 @@ name = "About Blurry"
2020
abstract = "Learn about Blurry, a static site generator build for page speed and SEO"
2121
datePublished = 2023-01-07
2222
image = "../images/blurry-logo.png"
23+
_is_this_available_in_a_template = True
2324
+++
2425

2526
# About Blurry
2627

2728
Regular Markdown content can go here.
2829
```
2930

31+
:::{info}
32+
Variables that are not in a Schema.org type but are useful in templates should start with the `FRONTMATTER_NON_SCHEMA_VARIABLE_PREFIX` [setting](../configuration/settings.md), which defaults to an underscore (`_`).
33+
:::
34+
3035
## Customizations
3136

3237
On top of [Mistune's built-in plugins](https://mistune.lepture.com/en/latest/plugins.html), Blurry ships with a number of Markdown customizations.

0 commit comments

Comments
 (0)