Skip to main content

Render content fields with Jinja2.

Project description

lektor-jinja-content

Build Status Code Coverage PyPI version PyPI - Python Version Code style: black

This is a Lektor plugin that allows you to render Jinja2 inside your content fields that are string-like. For example, this means that inside your content fields that are of type string or Markdown, you can write Jinja logic, and access Lektor's Template Context, and has access to all normal Jinja filters, including those provided by other plugins. In a Markdown field (or other field that is rendered - like rst), the Jinja is processed first, then the formatting processor.

You can set and use Jinja variables, but they will only have meaning within their field that is being rendered.

With this plugin, you'll have to make sure the content that is rendered is valid Jinja. Jinja syntax erros will throw an exception. Don't forget about the handy {% raw %} {% endraw %} tags if you want content that is not valid Jinja.

N.B. Using this plugin is rendering many more items with Jinja, and your build process will slow down as a result. As an early benchmark and anecdote, my small website's build time rose from 4.89s to 5.39s even while I actually had no Jinja-Content that needed rendering. I plan on adding the ability to configure this plugin later so that you don't have to run everything through Jinja if you don't want to.

Examples

Querying context: {{ site.get('/').title }} or {{ this.path }}

Logic:

{% set meaning_of_life, meaning_of_universe = this.life, this.universe %}
{% if meaning_of_life == meaning_of_universe == 42 %}
  {% set meaning_of_it_all = meaning_of_life %}
{% else %}
  {% set meaning_of_it_all = 'Undefined' %}
{% endif %}
{{ meaning_of_it_all }}

Jinja in Markdown:

[link text]({{ this|url }})

Jinja in reStructuredText:

`link text <{{ this|url }}>`_

Try running the test site for more examples.

Possible future of this plugin.

This Plugin opens the door to some pretty powerful and pretty funky functionality. Here's some food for though:

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

lektor-jinja-content-0.4.4.tar.gz (5.3 kB view details)

Uploaded Source

Built Distribution

lektor_jinja_content-0.4.4-py2.py3-none-any.whl (5.2 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file lektor-jinja-content-0.4.4.tar.gz.

File metadata

  • Download URL: lektor-jinja-content-0.4.4.tar.gz
  • Upload date:
  • Size: 5.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.4

File hashes

Hashes for lektor-jinja-content-0.4.4.tar.gz
Algorithm Hash digest
SHA256 fda5a1060062d9c1cad9a99be1aee0a5f87279a90712c441a09db6238daad558
MD5 ab1869e9d7dd3bf5e27f580687abf421
BLAKE2b-256 b5a91a2ed0b909bf6483f44e5386a981af6984f1f55f9fcff17824596b5fd7dc

See more details on using hashes here.

Provenance

File details

Details for the file lektor_jinja_content-0.4.4-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for lektor_jinja_content-0.4.4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 896d751903aad79f829820a7d4f658d59ef1826856f2318f6839fcad475d4c29
MD5 c7087a3adb54ed7e3e109f8a372f661b
BLAKE2b-256 9dd26af0850c83d74ea3c93c0de5b6ef0988359bea513b165f3fc78f477e7e05

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page