Skip to content

All variables supported by this documentation implementation:

Macros Plugin Environment#

General List#

All available variables and filters within the macros plugin:

Variable Type Content
extra dict version [dict], analytics [dict]
config MkDocsConfig {'config_file_path': '/home/ezra/workspace/github.com/ezrasilvera/edge-mc/docs/mike-mkdocsl_10a1mt.yml', 'site_name': 'KubeStellar', 'nav': [{'Welcome': [{'Landing': 'index.md'}]}, {'Overview': [{'Readme': 'readme.md'}, {'Architecture': 'direct/architecture.md'}, {'Release-notes': 'direct/release-notes.md'}]}, {'Getting Started': [{'Pre-reqs': 'direct/pre-reqs.md'}, {'Setting up KubeStellar': [{'Using existing hosting cluster': 'direct/hosting-cluster.md'}, {'KubeStellar on KIND': 'direct/ks-on-kind.md'}, {'KubeStellar on K3D': 'direct/deploy-on-k3d.md'}, {'KubeStellar on OCP': 'direct/ks-on-ocp.md'}]}, {'Examples': 'direct/examples.md'}]}, {'Contributing': [{'Overview of contributing': 'direct/contributor.md'}, {'Packaging': 'direct/packaging.md'}, {'Release Process': 'direct/release.md'}, {'Guidelines': 'Contribution guidelines/CONTRIBUTING.md'}, {'Code of Conduct': 'Contribution guidelines/coc.md'}, {'License': 'Contribution guidelines/LICENSE.md'}, {'Governance': 'Contribution guidelines/governance.md'}, {'Onboarding': 'Contribution guidelines/onboarding.md'}, {'Website': 'Contribution guidelines/operations/document-management.md'}, {'Security': [{'Policy': 'Contribution guidelines/security/security.md'}, {'Contacts': 'Contribution guidelines/security/security_contacts.md'}]}]}, {'Community': [{'Get Involved': 'Community/_index.md'}, {'Contact Us': [{'Mailing List': 'https://kubestellar.io/join_us'}, {'Community Meeting Agenda (join mailing list first)': 'https://kubestellar.io/agenda'}, {'Slack': 'https://kubestellar.io/slack'}, {'Medium Blog': 'https://kubestellar.io/blog'}, {'YouTube Channel': 'https://kubestellar.io/tv'}, {'LinkedIn': 'https://kubestellar.io/linkedin'}, {'Reddit': 'https://www.reddit.com/r/kubestellar/'}, {'Google Drive': 'https://drive.google.com/drive/u/1/folders/1p68MwkX0sYdTvtup0DcnAEsnXElobFLS'}]}, {'Partners': [{'ArgoCD': 'Community/partners/argocd.md'}, {'Turbonomic': 'Community/partners/turbonomic.md'}, {'MVI': 'Community/partners/mvi.md'}, {'FluxCD': 'Community/partners/fluxcd.md'}, {'OpenZiti': 'Community/partners/openziti.md'}, {'Kyverno': 'Community/partners/kyverno.md'}]}]}, {'Blog': 'https://medium.com/@kubestellar/list/predefined:e785a0675051:READING_LIST" target="_blank'}], 'pages': None, 'site_url': 'https://docs.kubestellar.io/release-0.21.2', 'site_description': None, 'site_author': None, 'theme': Theme(name='material', dirs=['/home/ezra/.local/lib/python3.10/site-packages/mkdocs_static_i18n/custom_i18n_sitemap', '/home/ezra/workspace/github.com/ezrasilvera/edge-mc/docs/overrides', '/home/ezra/.local/lib/python3.10/site-packages/material', '/home/ezra/.local/lib/python3.10/site-packages/mkdocs/templates'], static_templates=['sitemap.xml', '404.html'], name='material', locale=Locale(language='en', territory=''), language='en', direction=None, features=['content.action.edit', 'content.action.view', 'navigation.indexes', 'navigation.tabs', 'navigation.path', 'navigation.footer', 'content.code.copy', 'content.code.annotate'], palette={'primary': None, 'accent': None}, font={'text': 'SapceMono', 'code': 'Roboto Mono'}, icon=None, favicon='favicons/favicon.ico', logo='logo.png'), 'docs_dir': '/home/ezra/workspace/github.com/ezrasilvera/edge-mc/docs/content', 'site_dir': '/home/ezra/workspace/github.com/ezrasilvera/edge-mc/docs/generated', 'copyright': None, 'google_analytics': None, 'dev_addr': _IpAddressValue(host='127.0.0.1', port=8000), 'use_directory_urls': True, 'repo_url': 'https://github.com/kubestellar/kubestellar', 'repo_name': 'GitHub', 'edit_uri_template': None, 'edit_uri': 'edit/main/docs/content/', 'extra_css': ['stylesheets/kubestellar.css'], 'extra_javascript': ['js/open_in_new_tab.js'], 'extra_templates': [], 'markdown_extensions': ['toc', 'tables', 'fenced_code', 'markdown_captions', 'pymdownx.superfences', 'attr_list', 'md_in_html', 'pymdownx.highlight', 'pymdownx.inlinehilite', 'pymdownx.snippets', 'pymdownx.tabbed', 'admonition'], 'mdx_configs': {'pymdownx.superfences': {'custom_fences': [{'name': 'mermaid', 'class': 'mermaid', 'format': }]}, 'toc': {'permalink': '#'}, 'pymdownx.highlight': {'anchor_linenums': True, 'pygments_lang_class': True}, 'pymdownx.tabbed': {'alternate_style': True}}, 'strict': False, 'remote_branch': 'gh-pages', 'remote_name': 'origin', 'extra': {'version': {'default': 'stable', 'provider': 'mike'}, 'analytics': {'provider': 'google', 'property': 'G-SR5TD1CXY7', 'feedback': {'title': 'Was this page helpful?', 'ratings': [{'icon': 'material/emoticon-happy-outline', 'name': 'This page was helpful', 'data': 1, 'note': 'Thanks for your feedback!'}, {'icon': 'material/emoticon-sad-outline', 'name': 'This page could be improved', 'data': 0, 'note': 'Thanks for your feedback! Help us improve this page by using our feedback form.'}]}}}, 'plugins': {'mike': , 'awesome-pages': , 'material/search': , 'mermaid2': , 'open-in-new-tab': , 'include-markdown': , 'macros': , 'i18n': }, 'hooks': {}, 'watch': ['/home/ezra/workspace/github.com/ezrasilvera/edge-mc/docs/mkdocs.yml', '/home/ezra/workspace/github.com/ezrasilvera/edge-mc/docs/content', '/home/ezra/workspace/github.com/ezrasilvera/edge-mc/docs/overrides'], 'repo_short_name': 'kubestellar/kubestellar', 'repo_default_file_path': 'kubestellar', 'helm_repo_short_name': 'kubestellar/helm', 'helm_repo_default_file_path': 'helm', 'brew_repo_short_name': 'kubestellar/homebrew-kubestellar', 'brew_repo_default_file_path': 'homebrew-kubestellar', 'docs_url': 'https://docs.kubestellar.io', 'repo_raw_url': 'https://raw.githubusercontent.com/kubestellar/kubestellar', 'ks_branch': 'main', 'ks_tag': 'latest', 'ks_stable_tag': 'v0.9.0', 'ks_current_branch': 'release-0.15', 'ks_current_tag': 'v0.15.0', 'ks_current_helm_version': '8', 'ks_next_branch': 'release-0.16', 'ks_next_tag': 'v0.16.0', 'ks_next_helm_version': '9', 'ks_kind_port_num': '1119'}
environment dict system = 'Linux', system_version = '5.15.146.1-microsoft-standard-WSL2', python_version = '3.10.12', mkdocs_version = '1.4.2', macros_plugin_version = '0.7.0', jinja2_version = '3.1.2'
plugin LegacyConfig {'module_name': 'main', 'modules': [], 'include_dir': 'overrides', 'include_yaml': [], 'j2_block_start_string': '', 'j2_block_end_string': '', 'j2_variable_start_string': '', 'j2_variable_end_string': '', 'on_undefined': 'keep', 'on_error_fail': False, 'verbose': False}
git dict status = True, date [datetime], short_commit = '7d297a0d1', commit = '7d297a0d1ea500511612c920f7e241c17b866b72', tag = 'v0.21.2', author = 'kcp CI Bot', author_email = '134318005+kcp-ci-bot@users.noreply.github.com', committer = 'GitHub', committer_email = 'noreply@github.com', date_ISO = 'Tue Apr 2 10:56:02 2024 +0200', message = 'Merge pull request #2004 from ezrasilvera/r21.2\n\n:sparkles: Prep release 0.21.2', raw = 'commit 7d297a0d1ea500511612c920f7e241c17b866b72\nMerge: 8a42328bc fff2ed393\nAuthor: kcp CI Bot <134318005+kcp-ci-bot@users.noreply.github.com>\nDate: Tue Apr 2 10:56:02 2024 +0200\n\n Merge pull request #2004 from ezrasilvera/r21.2\n \n :sparkles: Prep release 0.21.2', root_dir = '/home/ezra/workspace/github.com/ezrasilvera/edge-mc'
version dict default = 'stable', provider = 'mike'
analytics dict provider = 'google', property = 'G-SR5TD1CXY7', feedback [dict]
macros SuperDict context [function], macros_info [function], now [function], fix_url [function], section_items [function]
filters dict pretty [function]
filters_builtin dict abs [builtin_function_or_method], attr [function], batch [function], capitalize [function], center [function], count [builtin_function_or_method], d [function], default [function], dictsort [function], e [builtin_function_or_method], escape [builtin_function_or_method], filesizeformat [function], first [function], float [function], forceescape [function], format [function], groupby [function], indent [function], int [function], join [function], last [function], length [builtin_function_or_method], list [function], lower [function], items [function], map [function], min [function], max [function], pprint [function], random [function], reject [function], rejectattr [function], replace [function], reverse [function], round [function], safe [function], select [function], selectattr [function], slice [function], sort [function], string [builtin_function_or_method], striptags [function], sum [function], title [function], trim [function], truncate [function], unique [function], upper [function], urlencode [function], urlize [function], wordcount [function], wordwrap [function], xmlattr [function], tojson [function]
navigation Navigation Section(title='Welcome')
Page(title='Landing', url='/release-0.21.2/')
Section(title='Overview')
Page(title='Readme', url='/release-0.21.2/readme/')
Page(title='Architecture', url='/release-0.21.2/direct/architecture/')
Page(title='Release-notes', url='/release-0.21.2/direct/release-notes/')
Section(title='Getting Started')
Page(title='Pre-reqs', url='/release-0.21.2/direct/pre-reqs/')
Section(title='Setting up KubeStellar')
Page(title='Using existing hosting cluster', url='/release-0.21.2/direct/hosting-cluster/')
Page(title='KubeStellar on KIND', url='/release-0.21.2/direct/ks-on-kind/')
Page(title='KubeStellar on K3D', url='/release-0.21.2/direct/deploy-on-k3d/')
Page(title='KubeStellar on OCP', url='/release-0.21.2/direct/ks-on-ocp/')
Page(title='Examples', url='/release-0.21.2/direct/examples/')
Section(title='Contributing')
Page(title='Overview of contributing', url='/release-0.21.2/direct/contributor/')
Page(title='Packaging', url='/release-0.21.2/direct/packaging/')
Page(title='Release Process', url='/release-0.21.2/direct/release/')
Page(title='Guidelines', url='/release-0.21.2/Contribution%20guidelines/CONTRIBUTING/')
Page(title='Code of Conduct', url='/release-0.21.2/Contribution%20guidelines/coc/')
Page(title='License', url='/release-0.21.2/Contribution%20guidelines/LICENSE/')
Page(title='Governance', url='/release-0.21.2/Contribution%20guidelines/governance/')
Page(title='Onboarding', url='/release-0.21.2/Contribution%20guidelines/onboarding/')
Page(title='Website', url='/release-0.21.2/Contribution%20guidelines/operations/document-management/')
Section(title='Security')
Page(title='Policy', url='/release-0.21.2/Contribution%20guidelines/security/security/')
Page(title='Contacts', url='/release-0.21.2/Contribution%20guidelines/security/security_contacts/')
Section(title='Community')
Page(title='Get Involved', url='/release-0.21.2/Community/_index/')
Section(title='Contact Us')
Link(title='Mailing List', url='https://kubestellar.io/join_us')
Link(title='Community Meeting Agenda (join mailing list first)', url='https://kubestellar.io/agenda')
Link(title='Slack', url='https://kubestellar.io/slack')
Link(title='Medium Blog', url='https://kubestellar.io/blog')
Link(title='YouTube Channel', url='https://kubestellar.io/tv')
Link(title='LinkedIn', url='https://kubestellar.io/linkedin')
Link(title='Reddit', url='https://www.reddit.com/r/kubestellar/')
Link(title='Google Drive', url='https://drive.google.com/drive/u/1/folders/1p68MwkX0sYdTvtup0DcnAEsnXElobFLS')
Section(title='Partners')
Page(title='ArgoCD', url='/release-0.21.2/Community/partners/argocd/')
Page(title='Turbonomic', url='/release-0.21.2/Community/partners/turbonomic/')
Page(title='MVI', url='/release-0.21.2/Community/partners/mvi/')
Page(title='FluxCD', url='/release-0.21.2/Community/partners/fluxcd/')
Page(title='OpenZiti', url='/release-0.21.2/Community/partners/openziti/')
Page(title='Kyverno', url='/release-0.21.2/Community/partners/kyverno/')
Link(title='Blog', url='https://medium.com/@kubestellar/list/predefined:e785a0675051:READING_LIST" target="_blank')
files I18nFiles
page Page Page(title='All macros', url='/release-0.21.2/Contribution%20guidelines/operations/all-macros/')

Config Information#

Standard MkDocs configuration information. Do not try to modify.

e.g. {{ config.docs_dir }}

See also the MkDocs documentation on the config object.

Variable Type Content
config_file_path str '/home/ezra/workspace/github.com/ezrasilvera/edge-mc/docs/mike-mkdocsl_10a1mt.yml'
site_name str 'KubeStellar'
nav list [{'Welcome': [{'Landing': 'index.md'}]}, {'Overview': [{'Readme': 'readme.md'}, {'Architecture': 'direct/architecture.md'}, {'Release-notes': 'direct/release-notes.md'}]}, {'Getting Started': [{'Pre-reqs': 'direct/pre-reqs.md'}, {'Setting up KubeStellar': [{'Using existing hosting cluster': 'direct/hosting-cluster.md'}, {'KubeStellar on KIND': 'direct/ks-on-kind.md'}, {'KubeStellar on K3D': 'direct/deploy-on-k3d.md'}, {'KubeStellar on OCP': 'direct/ks-on-ocp.md'}]}, {'Examples': 'direct/examples.md'}]}, {'Contributing': [{'Overview of contributing': 'direct/contributor.md'}, {'Packaging': 'direct/packaging.md'}, {'Release Process': 'direct/release.md'}, {'Guidelines': 'Contribution guidelines/CONTRIBUTING.md'}, {'Code of Conduct': 'Contribution guidelines/coc.md'}, {'License': 'Contribution guidelines/LICENSE.md'}, {'Governance': 'Contribution guidelines/governance.md'}, {'Onboarding': 'Contribution guidelines/onboarding.md'}, {'Website': 'Contribution guidelines/operations/document-management.md'}, {'Security': [{'Policy': 'Contribution guidelines/security/security.md'}, {'Contacts': 'Contribution guidelines/security/security_contacts.md'}]}]}, {'Community': [{'Get Involved': 'Community/_index.md'}, {'Contact Us': [{'Mailing List': 'https://kubestellar.io/join_us'}, {'Community Meeting Agenda (join mailing list first)': 'https://kubestellar.io/agenda'}, {'Slack': 'https://kubestellar.io/slack'}, {'Medium Blog': 'https://kubestellar.io/blog'}, {'YouTube Channel': 'https://kubestellar.io/tv'}, {'LinkedIn': 'https://kubestellar.io/linkedin'}, {'Reddit': 'https://www.reddit.com/r/kubestellar/'}, {'Google Drive': 'https://drive.google.com/drive/u/1/folders/1p68MwkX0sYdTvtup0DcnAEsnXElobFLS'}]}, {'Partners': [{'ArgoCD': 'Community/partners/argocd.md'}, {'Turbonomic': 'Community/partners/turbonomic.md'}, {'MVI': 'Community/partners/mvi.md'}, {'FluxCD': 'Community/partners/fluxcd.md'}, {'OpenZiti': 'Community/partners/openziti.md'}, {'Kyverno': 'Community/partners/kyverno.md'}]}]}, {'Blog': 'https://medium.com/@kubestellar/list/predefined:e785a0675051:READING_LIST" target="_blank'}]
pages NoneType None
site_url str 'https://docs.kubestellar.io/release-0.21.2'
site_description NoneType None
site_author NoneType None
theme Theme Theme(name='material', dirs=['/home/ezra/.local/lib/python3.10/site-packages/mkdocs_static_i18n/custom_i18n_sitemap', '/home/ezra/workspace/github.com/ezrasilvera/edge-mc/docs/overrides', '/home/ezra/.local/lib/python3.10/site-packages/material', '/home/ezra/.local/lib/python3.10/site-packages/mkdocs/templates'], static_templates=['sitemap.xml', '404.html'], name='material', locale=Locale(language='en', territory=''), language='en', direction=None, features=['content.action.edit', 'content.action.view', 'navigation.indexes', 'navigation.tabs', 'navigation.path', 'navigation.footer', 'content.code.copy', 'content.code.annotate'], palette={'primary': None, 'accent': None}, font={'text': 'SapceMono', 'code': 'Roboto Mono'}, icon=None, favicon='favicons/favicon.ico', logo='logo.png')
docs_dir str '/home/ezra/workspace/github.com/ezrasilvera/edge-mc/docs/content'
site_dir str '/home/ezra/workspace/github.com/ezrasilvera/edge-mc/docs/generated'
copyright NoneType None
google_analytics NoneType None
dev_addr _IpAddressValue _IpAddressValue(host='127.0.0.1', port=8000)
use_directory_urls bool True
repo_url str 'https://github.com/kubestellar/kubestellar'
repo_name str 'GitHub'
edit_uri_template NoneType None
edit_uri str 'edit/main/docs/content/'
extra_css list ['stylesheets/kubestellar.css']
extra_javascript list ['js/open_in_new_tab.js']
extra_templates list []
markdown_extensions list ['toc', 'tables', 'fenced_code', 'markdown_captions', 'pymdownx.superfences', 'attr_list', 'md_in_html', 'pymdownx.highlight', 'pymdownx.inlinehilite', 'pymdownx.snippets', 'pymdownx.tabbed', 'admonition']
mdx_configs dict pymdownx.superfences [dict], toc [dict], pymdownx.highlight [dict], pymdownx.tabbed [dict]
strict bool False
remote_branch str 'gh-pages'
remote_name str 'origin'
extra LegacyConfig {'version': {'default': 'stable', 'provider': 'mike'}, 'analytics': {'provider': 'google', 'property': 'G-SR5TD1CXY7', 'feedback': {'title': 'Was this page helpful?', 'ratings': [{'icon': 'material/emoticon-happy-outline', 'name': 'This page was helpful', 'data': 1, 'note': 'Thanks for your feedback!'}, {'icon': 'material/emoticon-sad-outline', 'name': 'This page could be improved', 'data': 0, 'note': 'Thanks for your feedback! Help us improve this page by using our feedback form.'}]}}}
plugins PluginCollection mike [MikePlugin], awesome-pages [AwesomePagesPlugin], material/search [SearchPlugin], mermaid2 [MarkdownMermaidPlugin], open-in-new-tab [OpenInNewTabPlugin], include-markdown [IncludeMarkdownPlugin], macros [MacrosPlugin], i18n [I18n]
hooks dict
watch list ['/home/ezra/workspace/github.com/ezrasilvera/edge-mc/docs/mkdocs.yml', '/home/ezra/workspace/github.com/ezrasilvera/edge-mc/docs/content', '/home/ezra/workspace/github.com/ezrasilvera/edge-mc/docs/overrides']
repo_short_name str 'kubestellar/kubestellar'
repo_default_file_path str 'kubestellar'
helm_repo_short_name str 'kubestellar/helm'
helm_repo_default_file_path str 'helm'
brew_repo_short_name str 'kubestellar/homebrew-kubestellar'
brew_repo_default_file_path str 'homebrew-kubestellar'
docs_url str 'https://docs.kubestellar.io'
repo_raw_url str 'https://raw.githubusercontent.com/kubestellar/kubestellar'
ks_branch str 'main'
ks_tag str 'latest'
ks_stable_tag str 'v0.9.0'
ks_current_branch str 'release-0.15'
ks_current_tag str 'v0.15.0'
ks_current_helm_version str '8'
ks_next_branch str 'release-0.16'
ks_next_tag str 'v0.16.0'
ks_next_helm_version str '9'
ks_kind_port_num str '1119'

Macros#

These macros have been defined programmatically for this environment (module or pluglets).

Variable Type Content
context function (obj, e)

Default mkdocs_macro List the defined variables

macros_info function ()

Test/debug function: list useful documentation on the mkdocs_macro environment.

now function ()

Get the current time (returns a datetime object). Used alone, it provides a timestamp. To get the year use now().year, for the month number now().month, etc.

fix_url function (url, r)

If url is relative, fix it so that it points to the docs diretory. This is necessary because relative links in markdown must be adapted in html ('img/foo.png' => '../img/img.png').

section_items function (page, nav, config, children, siblings, child)

Returns a list of all pages that are siblings to page.

Git Information#

Information available on the last commit and the git repository containing the documentation project:

e.g. {{ git.message }}

Variable Type Content
status bool True
date datetime datetime.datetime(2024, 4, 2, 10, 56, 2, tzinfo=tzoffset(None, 7200))
short_commit str '7d297a0d1'
commit str '7d297a0d1ea500511612c920f7e241c17b866b72'
tag str 'v0.21.2'
author str 'kcp CI Bot'
author_email str '134318005+kcp-ci-bot@users.noreply.github.com'
committer str 'GitHub'
committer_email str 'noreply@github.com'
date_ISO str 'Tue Apr 2 10:56:02 2024 +0200'
message str 'Merge pull request #2004 from ezrasilvera/r21.2\n\n:sparkles: Prep release 0.21.2'
raw str 'commit 7d297a0d1ea500511612c920f7e241c17b866b72\nMerge: 8a42328bc fff2ed393\nAuthor: kcp CI Bot <134318005+kcp-ci-bot@users.noreply.github.com>\nDate: Tue Apr 2 10:56:02 2024 +0200\n\n Merge pull request #2004 from ezrasilvera/r21.2\n \n :sparkles: Prep release 0.21.2'
root_dir str '/home/ezra/workspace/github.com/ezrasilvera/edge-mc'

Page Attributes#

Provided by MkDocs. These attributes change for every page (the attributes shown are for this page).

e.g. {{ page.title }}

See also the MkDocs documentation on the page object.

Variable Type Content
file I18nFile I18nFile(src_path='Contribution guidelines/operations/all-macros.md', abs_src_path='/home/ezra/workspace/github.com/ezrasilvera/edge-mc/docs/content/Contribution guidelines/operations/all-macros.md', dest_path='Contribution guidelines/operations/all-macros/index.html', abs_dest_path='/home/ezra/workspace/github.com/ezrasilvera/edge-mc/docs/generated/Contribution guidelines/operations/all-macros/index.html', name='all-macros', locale_suffix='None', dest_language='', dest_name='all-macros.md', url='Contribution%20guidelines/operations/all-macros/')
title str 'All macros'
parent NoneType None
children NoneType None
previous_page NoneType None
next_page NoneType None
_Page__active bool False
update_date str '2024-04-02'
canonical_url str 'https://docs.kubestellar.io/release-0.21.2/Contribution%20guidelines/operations/all-macros/'
abs_url str '/release-0.21.2/Contribution%20guidelines/operations/all-macros/'
edit_url str 'https://github.com/kubestellar/kubestellar/edit/main/docs/content/Contribution guidelines/operations/all-macros.md'
markdown str 'All variables supported by this documentation implementation:\n\n{{ macros_info() }}'
content NoneType None
toc list []
meta dict

To have all titles of all pages, use:

{% for page in navigation.pages %}
- {{ page.title }}
{% endfor %}

Plugin Filters#

These filters are provided as a standard by the macros plugin.

Variable Type Content
pretty function (var_list, rows, header, e)

Default mkdocs_macro Prettify a dictionary or object (used for environment documentation, or debugging).

Builtin Jinja2 Filters#

These filters are provided by Jinja2 as a standard.

See also the Jinja2 documentation on builtin filters).

Variable Type Content
abs builtin_function_or_method

Return the absolute value of the argument.

attr function (environment, obj, name, value)

Get an attribute of an object. foo|attr("bar") works like foo.bar just that always an attribute is returned and items are not looked up.

batch function (value, linecount, fill_with, tmp, item)

A filter that batches items. It works pretty much like slice just the other way round. It returns a list of lists with the given number of items. If you provide a second parameter this is used to fill up missing items. See this example.

capitalize function (s)

Capitalize a value. The first character will be uppercase, all others lowercase.

center function (value, width)

Centers the value in a field of a given width.

count builtin_function_or_method

Return the number of items in a container.

d function (value, default_value, boolean)

If the value is undefined it will return the passed default value, otherwise the value of the variable.

default function (value, default_value, boolean)

If the value is undefined it will return the passed default value, otherwise the value of the variable.

dictsort function (value, case_sensitive, by, reverse, sort_func)

Sort a dict and yield (key, value) pairs. Python dicts may not be in the order you want to display them in, so sort them first.

e builtin_function_or_method

Replace the characters &, <, >, ', and " in the string with HTML-safe sequences. Use this if you need to display text that might contain such characters in HTML.

escape builtin_function_or_method

Replace the characters &, <, >, ', and " in the string with HTML-safe sequences. Use this if you need to display text that might contain such characters in HTML.

filesizeformat function (value, binary, bytes, base, prefixes, i, prefix, unit)

Format the value like a 'human-readable' file size (i.e. 13 kB, 4.1 MB, 102 Bytes, etc). Per default decimal prefixes are used (Mega, Giga, etc.), if the second parameter is set to True the binary prefixes are used (Mebi, Gibi).

first function (args, kwargs, b)

Return the first item of a sequence.

float function (value, default)

Convert the value into a floating point number. If the conversion doesn't work it will return 0.0. You can override this default using the first parameter.

forceescape function (value)

Enforce HTML escaping. This will probably double escape variables.

format function (value, args, kwargs)

Apply the given values to a printf-style_ format string, like string % values.

groupby function (args, kwargs, b)

Group a sequence of objects by an attribute using Python's :func:itertools.groupby. The attribute can use dot notation for nested access, like "address.city". Unlike Python's groupby, the values are sorted first so only one group is returned for each unique value.

indent function (s, width, first, blank, newline, rv, lines)

Return a copy of the string with each line indented by 4 spaces. The first line and blank lines are not indented by default.

int function (value, default, base)

Convert the value into an integer. If the conversion doesn't work it will return 0. You can override this default using the first parameter. You can also override the default base (10) in the second parameter, which handles input with prefixes such as 0b, 0o and 0x for bases 2, 8 and 16 respectively. The base is ignored for decimal numbers and non-string values.

join function (args, kwargs, b)

Return a string which is the concatenation of the strings in the sequence. The separator between elements is an empty string per default, you can define it with the optional parameter.

last function (environment, seq)

Return the last item of a sequence.

length builtin_function_or_method

Return the number of items in a container.

list function (args, kwargs, b)

Convert the value into a list. If it was a string the returned list will be a list of characters.

lower function (s)

Convert a value to lowercase.

items function (value)

Return an iterator over the (key, value) items of a mapping.

map function (args, kwargs, b)

Applies a filter on a sequence of objects or looks up an attribute. This is useful when dealing with lists of objects but you are really only interested in a certain value of it.

min function (environment, value, case_sensitive, attribute)

Return the smallest item from the sequence.

max function (environment, value, case_sensitive, attribute)

Return the largest item from the sequence.

pprint function (value)

Pretty print a variable. Useful for debugging.

random function (context, seq)

Return a random item from the sequence.

reject function (args, kwargs, b)

Filters a sequence of objects by applying a test to each object, and rejecting the objects with the test succeeding.

rejectattr function (args, kwargs, b)

Filters a sequence of objects by applying a test to the specified attribute of each object, and rejecting the objects with the test succeeding.

replace function (eval_ctx, s, old, new, count)

Return a copy of the value with all occurrences of a substring replaced with a new one. The first argument is the substring that should be replaced, the second is the replacement string. If the optional third argument count is given, only the first count occurrences are replaced.

reverse function (value, rv, e)

Reverse the object or return an iterator that iterates over it the other way round.

round function (value, precision, method, func)

Round the number to a given precision. The first parameter specifies the precision (default is 0), the second the rounding method.

safe function (value)

Mark the value as safe which means that in an environment with automatic escaping enabled this variable will not be escaped.

select function (args, kwargs, b)

Filters a sequence of objects by applying a test to each object, and only selecting the objects with the test succeeding.

selectattr function (args, kwargs, b)

Filters a sequence of objects by applying a test to the specified attribute of each object, and only selecting the objects with the test succeeding.

slice function (args, kwargs, b)

Slice an iterator and return a list of lists containing those items. Useful if you want to create a div containing three ul tags that represent columns.

sort function (environment, value, reverse, case_sensitive, attribute, key_func)

Sort an iterable using Python's :func:sorted.

string builtin_function_or_method

Convert an object to a string if it isn't already. This preserves a :class:Markup string rather than converting it back to a basic string, so it will still be marked as safe and won't be escaped again.

striptags function (value)

Strip SGML/XML tags and replace adjacent whitespace by one space.

sum function (args, kwargs, b)

Returns the sum of a sequence of numbers plus the value of parameter 'start' (which defaults to 0). When the sequence is empty it returns start.

title function (s)

Return a titlecased version of the value. I.e. words will start with uppercase letters, all remaining characters are lowercase.

trim function (value, chars)

Strip leading and trailing characters, by default whitespace.

truncate function (env, s, length, killwords, end, leeway, result)

Return a truncated copy of the string. The length is specified with the first parameter which defaults to 255. If the second parameter is true the filter will cut the text at length. Otherwise it will discard the last word. If the text was in fact truncated it will append an ellipsis sign ("..."). If you want a different ellipsis sign than "..." you can specify it using the third parameter. Strings that only exceed the length by the tolerance margin given in the fourth parameter will not be truncated.

unique function (environment, value, case_sensitive, attribute, getter, seen, item, key)

Returns a list of unique items from the given iterable.

upper function (s)

Convert a value to uppercase.

urlencode function (value, items)

Quote data for use in a URL path or query using UTF-8.

urlize function (eval_ctx, value, trim_url_limit, nofollow, target, rel, extra_schemes, policies, rel_parts, scheme, rv)

Convert URLs in text into clickable links.

wordcount function (s)

Count the words in that string.

wordwrap function (environment, s, width, break_long_words, wrapstring, break_on_hyphens)

Wrap a string to the given width. Existing newlines are treated as paragraphs to be wrapped separately.

xmlattr function (eval_ctx, d, autospace, rv)

Create an SGML/XML attribute string based on the items in a dict. All values that are neither none nor undefined are automatically escaped.

tojson function (eval_ctx, value, indent, policies, dumps, kwargs)

Serialize an object to a string of JSON, and mark it safe to render in HTML. This filter is only for use in HTML documents.