Metadata-Version: 2.1
Name: jinja-frontmatter
Version: 0.1.0
Summary: Frontmatter support for Jinja templates
Home-page: https://github.com/hyperflask/jinja-frontmatter
License: MIT
Author: Maxime Bouroumeau-Fuseau
Author-email: maxime.bouroumeau@gmail.com
Requires-Python: >=3.8,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: jinja2 (>=3.0.0,<4.0.0)
Requires-Dist: pyyaml (>=6.0.0,<7.0.0)
Project-URL: Repository, https://github.com/hyperflask/jinja-frontmatter
Description-Content-Type: text/markdown

# Jinja-Frontmatter

Utilities to handle frontmatters in Jinja templates

## Installation

    pip install jinja-frontmatter

## Remove frontmatter from templates

```python
from jinja2 import Environment, PackageLoader
from jinja_frontmatter import RemoveFrontmatterLoader, get_template_frontmatter
import yaml

env = Environment(loader=RemoveFrontmatterLoader(PackageLoader(__name__, 'templates')))
frontmatter = get_template_frontmatter(env, "template.html") # frontmatter as text
frontmatter = get_template_frontmatter(env, "template.html", loads=yaml.safe_load) # frontmatter as yaml
```

## Access YAML frontmatters in templates

```python
from jinja2 import Environment, PackageLoader
from jinja_frontmatter import YAMLFrontmatterExtension

env = Environment(loader=PackageLoader(__name__, 'templates'))
env.add_extension(YAMLFrontmatterExtension)
```

In your template:

```
---
foo: bar
---
{{ frontmatter.foo }}
```

