Skip to content

Utility filters

The jinja2 environment also contains some pre-defined filters.

Info

The output gets passed to the first argument of the filter function. Filters are separated from the variable by a pipe symbol (|) and may have optional arguments in parentheses. Multiple filters can be chained. The output of one filter is applied to the next.

A base collection of filters is provided by jinjarope

Additional filters provided by MkNodes:

Example:

"PageName" | get_link

Return a markdown link for given target.

Target can be a class, a module, a MkPage, MkNav or a string.

Parameters:

Name Type Description Default
target LinkableType

The thing to link to

required
title str | None

The title to use for the link

None

get_url

Example:

"PageName" | get_url

Get a url for given target.

Target can be a class, a module, a MkPage, MkNav or a string.

Parameters:

Name Type Description Default
target LinkableType

The thing to link to

required

TODO