Macros Plugin Environment¶
General List¶
All available variables and filters within the macros plugin:
Variable | Type | Content |
---|---|---|
extra | dict | |
config | MkDocsConfig | {'config_file_path': '/builds/davinsony/ares/mkdocs.yml', 'site_name': 'Semillero ARES', 'nav': [{'Inicio': 'index.md'}, {'Proyectos': [{'Brazo Robótico': 'proyecto/SCARA/index.md'}, {'Plataforma Móvil': 'proyecto/Zombie/index.md'}, {'EV3 Bluetooth': 'proyecto/EV3-bluetooth/index.md'}, {'OpenCV con Python': 'proyecto/OpenCV/index.md'}, {'Anteriores': [{'Robot Delta': 'proyecto/Delta/index.md'}, {'EV3 Micropython': 'proyecto/EV3-micropython/index.md'}, {'PaCo': 'proyecto/paco/index.md'}]}]}, {'Recursos': [{'Ofertas de Trabajo': 'recurso/trabajo.md'}, {'Laboratorios': 'recurso/laboratorios.md'}, {'Python': 'recurso/python.md'}, {'ROS': 'recurso/ros.md'}, {'Markdown': 'recurso/markdown.md'}, {'Github Desktop': 'recurso/github-desktop.md'}]}, {'Tutoriales': [{'Instalar Ubuntu en USB': 'tutorial/ubuntu/index.md'}, {'Linux': [{'Comandos de Linux': 'tutorial/linux/index.md'}, {'Editor VI': 'tutorial/linux/vi.md'}, {'bash': 'tutorial/linux/bash.md'}]}, {'Cpp': 'tutorial/C++/index.md'}, {'WSL': 'tutorial/WSL/index.md'}, {'ROS2': [{'Introducción': 'tutorial/ROS2/index.md'}, {'ROS2 con Python': 'tutorial/ROS2/ROS2PY.md'}]}, {'Nav2': 'tutorial/nav2/index.md'}, {'Electrónica': [{'Introducción': 'tutorial/electronica/index.md'}, {'Divisor de Tensión': 'tutorial/electronica/divisor-tension.md'}, {'Suiches': 'tutorial/electronica/suiche.md'}, {'LED': 'tutorial/electronica/led.md'}, {'Semiconductores': 'tutorial/electronica/semiconductor.md'}]}]}, {'Semillero': [{'Actas': 'acta/index.md'}, {'Contacto': 'contacto.md'}, {'Inscripción': 'https://forms.office.com/r/ckjAxv6n1n'}, {'Miembros': 'miembro/index.md'}, {'Canal YouTube': 'https://www.youtube.com/channel/UCnFF6O1mzq8r9tDKErtZGTA?sub_confirmation=1'}, {'Description (en)': 'en.md'}]}], 'pages': None, 'site_url': 'https://ares.davinsony.com/', 'site_description': None, 'site_author': 'Davinson Castaño', 'theme': Theme(name='mkdocs', dirs=['/builds/davinsony/ares/theme/', '/usr/local/lib/python3.11/site-packages/mkdocs/themes/mkdocs', '/usr/local/lib/python3.11/site-packages/mkdocs/templates', '/usr/local/lib/python3.11/site-packages/mkdocs/contrib/search/templates'], static_templates=['404.html', 'sitemap.xml'], name='mkdocs', locale=Locale(language='es', territory=''), include_search_page=False, search_index_only=False, highlightjs=True, hljs_languages=[], hljs_style='github', navigation_depth=2, nav_style='primary', analytics={'gtag': 'G-JK3EXWH3B4'}, shortcuts={'help': 191, 'next': 78, 'previous': 80, 'search': 83}), 'docs_dir': '/builds/davinsony/ares/docs', 'site_dir': '/builds/davinsony/ares/public', 'copyright': 'Copyright © 2019-2023 Davinson Castaño. Contenido creado por los estudiantes del Semillero.', 'google_analytics': None, 'dev_addr': _IpAddressValue(host='127.0.0.1', port=8000), 'use_directory_urls': True, 'repo_url': None, 'repo_name': None, 'edit_uri_template': None, 'edit_uri': None, 'extra_css': ['css/extra.css'], 'extra_javascript': ['https://polyfill.io/v3/polyfill.min.js?features=es6', 'https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js', 'js/mathjax.js', 'js/https.js', 'search/main.js'], 'extra_templates': [], 'markdown_extensions': ['toc', 'tables', 'fenced_code', 'admonition', 'attr_list', 'codehilite', 'def_list', 'sane_lists'], 'mdx_configs': {'toc': {'permalink': True}}, 'strict': False, 'remote_branch': 'gh-pages', 'remote_name': 'origin', 'extra': {}, 'plugins': {'search': |
miembros | list | [{'nombre': 'Alexander Garcia Giraldo', 'correo': '', 'telefono': '', 'inicio': '2019-1', 'fin': '2020-1', 'cargo': 'Fundador', 'uri': 'https://www.linkedin.com/in/alexander-garcia-75618593/'}, {'nombre': 'Andres David Mazo Bosnio', 'correo': '', 'telefono': '', 'inicio': '2019-1', 'fin': '2019-2', 'cargo': 'Fundador, Ex-coordinador', 'uri': 'https://www.linkedin.com/in/andres-mazo-1a455a210/'}, {'nombre': 'Davinson Castano Cano', 'correo': '', 'telefono': '', 'inicio': '2019-1', 'fin': '', 'cargo': 'Profesor Coordinador', 'uri': '/miembro/dcasta25'}, {'nombre': 'Juan David Montano Toro', 'correo': '', 'telefono': '', 'inicio': '2019-1', 'fin': '2019-2', 'cargo': 'Fundador', 'uri': ''}, {'nombre': 'Luis Fernando Alzate Urrea', 'correo': '', 'telefono': '', 'inicio': '2019-1', 'fin': '2019-2', 'cargo': 'Fundador', 'uri': 'https://www.linkedin.com/in/luis-fernando-alzate-urrea-b06642175/'}, {'nombre': 'Miguel Castano Marin', 'correo': '', 'telefono': '', 'inicio': '2019-1', 'fin': '2022-2', 'cargo': 'Fundador, Ex-coordinador', 'uri': ''}, {'nombre': 'David Antonio Toro Medina', 'correo': '', 'telefono': '', 'inicio': '2019-2', 'fin': '2019-2', 'cargo': '', 'uri': 'https://www.linkedin.com/in/david-antonio-toro-medina-87695a168/'}, {'nombre': 'Juan Felipe Martinez', 'correo': '', 'telefono': '', 'inicio': '2020-1', 'fin': '2022-2', 'cargo': '', 'uri': 'https://www.linkedin.com/in/juan-felipe-mart%C3%ADnez-bedoya-a6ab53248/'}, {'nombre': 'Juan Pablo Delgado Marcillo', 'correo': '', 'telefono': '', 'inicio': '2020-1', 'fin': '2020-1', 'cargo': '', 'uri': ''}, {'nombre': 'Alejandro Lopez Giraldo', 'correo': '', 'telefono': '', 'inicio': '2020-2', 'fin': '2021-1', 'cargo': '', 'uri': 'https://www.linkedin.com/in/alopezgiraldo/'}, {'nombre': 'Carolina Henao Uribe', 'correo': '', 'telefono': '', 'inicio': '2020-2', 'fin': '2021-1', 'cargo': '', 'uri': 'https://www.linkedin.com/in/carolina-henao-uribe-17759610a/'}, {'nombre': 'Gildardo Henao Jaramillo', 'correo': '', 'telefono': '', 'inicio': '2020-2', 'fin': '2020-2', 'cargo': '', 'uri': ''}, {'nombre': 'Jacobo Arango Montoya', 'correo': '', 'telefono': '', 'inicio': '2020-2', 'fin': '2021-1', 'cargo': '', 'uri': 'https://www.linkedin.com/in/jacobo-arango-montoya-4863b41b2/'}, {'nombre': 'Juan Pablo Tamayo Villa', 'correo': '', 'telefono': '', 'inicio': '2020-2', 'fin': '2020-2', 'cargo': '', 'uri': ''}, {'nombre': 'Luis Esteban Giraldo Quintero', 'correo': '', 'telefono': '', 'inicio': '2020-2', 'fin': '2021-2', 'cargo': '', 'uri': ''}, {'nombre': 'Marcos Daniel Reyes Garces', 'correo': '', 'telefono': '', 'inicio': '2020-2', 'fin': '2021-1', 'cargo': '', 'uri': ''}, {'nombre': 'Maria Clara Henao Penaranda', 'correo': '', 'telefono': '', 'inicio': '2020-2', 'fin': '2021-1', 'cargo': '', 'uri': 'https://www.linkedin.com/in/maria-clara-henao/'}, {'nombre': 'Nicolas Villamizar Sanchez', 'correo': '', 'telefono': '', 'inicio': '2020-2', 'fin': '2021-1', 'cargo': '', 'uri': 'https://www.linkedin.com/in/nicolas-villamizar-7b4587187/'}, {'nombre': 'David Escobar Gallego', 'correo': '', 'telefono': '', 'inicio': '2021-1', 'fin': '2021-1', 'cargo': '', 'uri': ''}, {'nombre': 'Elizabeth Miranda Montoya', 'correo': '', 'telefono': '', 'inicio': '2021-1', 'fin': '2021-1', 'cargo': '', 'uri': ''}, {'nombre': 'Jorge Daniel Paez Vivas', 'correo': '', 'telefono': '', 'inicio': '2021-1', 'fin': '2021-1', 'cargo': '', 'uri': ''}, {'nombre': 'Andrea Giraldo Osorio', 'correo': '', 'telefono': '', 'inicio': '2022-1', 'fin': '2022-1', 'cargo': '', 'uri': 'https://www.linkedin.com/in/andrea-giraldo-osorio-14b98022b/'}, {'nombre': 'Maria Camila Maldonado Zuluaga', 'correo': '', 'telefono': '', 'inicio': '2022-1', 'fin': '2022-2', 'cargo': 'Ex-Coordinadora', 'uri': '/miembro/mcmaldonaz'}, {'nombre': 'Martin Rodriguez Mazo', 'correo': '', 'telefono': '', 'inicio': '2022-1', 'fin': '2022-2', 'cargo': '', 'uri': ''}, {'nombre': 'Joan Beltran Guerrero', 'correo': '', 'telefono': '', 'inicio': '2022-2', 'fin': '2022-2', 'cargo': '', 'uri': '/miembro/jbeltrang'}, {'nombre': 'Joan Francisco Alvarado Molina', 'correo': '', 'telefono': '', 'inicio': '2022-2', 'fin': '2022-2', 'cargo': '', 'uri': ''}, {'nombre': 'Maria Paula', 'correo': '', 'telefono': '', 'inicio': '2022-2', 'fin': '2022-2', 'cargo': '', 'uri': ''}, {'nombre': 'Stefania Valencia Herrera', 'correo': '', 'telefono': '', 'inicio': '2022-2', 'fin': '2022-2', 'cargo': 'Ex-Coordinadora', 'uri': '/miembro/svalenciah'}, {'nombre': 'Alfonso Celimo Fierro Lopez', 'correo': '[email protected]', 'telefono': '3044719211', 'inicio': '2023-02', 'fin': '', 'cargo': '', 'uri': ''}, {'nombre': 'Andrés Felipe Puerta Vélez', 'correo': '[email protected]', 'telefono': '3245639653', 'inicio': '2023-02', 'fin': '', 'cargo': '', 'uri': ''}, {'nombre': 'Angie Yuliana Navarro Hurtado', 'correo': '[email protected]', 'telefono': '3127061578', 'inicio': '2023-02', 'fin': '', 'cargo': '', 'uri': ''}, {'nombre': 'Daniel Esteban Marin Marin', 'correo': '[email protected]', 'telefono': '3006297757', 'inicio': '2023-02', 'fin': '', 'cargo': '', 'uri': ''}, {'nombre': 'Jeferson Stiven Lindarte Ovallos', 'correo': '[email protected]', 'telefono': '3185271941', 'inicio': '2023-02', 'fin': '', 'cargo': '', 'uri': ''}, {'nombre': 'Jose Daniel Arenas Villegas', 'correo': '[email protected]', 'telefono': '3216995789', 'inicio': '2023-02', 'fin': '', 'cargo': '', 'uri': ''}, {'nombre': 'Juan Fernando Riascos Goyes', 'correo': '[email protected]', 'telefono': '3053432617', 'inicio': '2023-02', 'fin': '', 'cargo': '', 'uri': ''}, {'nombre': 'Juan Manuel Cano Mejía', 'correo': '[email protected]', 'telefono': '3106028025', 'inicio': '2023-02', 'fin': '', 'cargo': '', 'uri': ''}, {'nombre': 'Julian Andres Diaz Quintero', 'correo': '[email protected]', 'telefono': '3228246521', 'inicio': '2023-02', 'fin': '', 'cargo': '', 'uri': ''}, {'nombre': 'Luis Miguel Loaiza Zapata', 'correo': '[email protected]', 'telefono': '3172218236', 'inicio': '2023-02', 'fin': '', 'cargo': '', 'uri': ''}, {'nombre': 'Marian Fernanda Garcia Cardona', 'correo': '[email protected]', 'telefono': '3023679297', 'inicio': '2023-02', 'fin': '', 'cargo': '', 'uri': ''}, {'nombre': 'Nelson Jose Bayona Arizal', 'correo': '[email protected]', 'telefono': '317119849', 'inicio': '2023-02', 'fin': '', 'cargo': '', 'uri': ''}, {'nombre': 'Sebastian Jimenez Henao', 'correo': '[email protected]', 'telefono': '3054042019', 'inicio': '2023-02', 'fin': '', 'cargo': '', 'uri': ''}, {'nombre': 'Catalina Rodriguez Cardona', 'correo': '[email protected]', 'telefono': '3045451136', 'inicio': '2023-02', 'fin': '', 'cargo': '', 'uri': ''}, {'nombre': 'Valentina Hurtatis Orozco', 'correo': '[email protected]', 'telefono': '3123658257', 'inicio': '2023-02', 'fin': '', 'cargo': '', 'uri': ''}] |
environment | dict | system = 'Linux', system_version = '5.4.109+', python_version = '3.11.3', mkdocs_version = '1.4.2', macros_plugin_version = '0.7.0', jinja2_version = '3.1.2' |
plugin | LegacyConfig | {'module_name': 'main', 'modules': [], 'include_dir': '', 'include_yaml': ['data/miembros.yml'], '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 = '5bf1952', commit = '5bf1952db5d90ce40dcba50c5752687265755e0a', tag = '', author = 'Davinson CASTANO', author_email = '[email protected]', committer = 'Davinson CASTANO', committer_email = '[email protected]', date_ISO = 'Thu Apr 20 11:53:35 2023 -0500', message = 'acta de 20 de abril', raw = 'commit 5bf1952db5d90ce40dcba50c5752687265755e0a\nAuthor: Davinson CASTANO |
macros | SuperDict | context [function], macros_info [function], now [function], fix_url [function], ls [function], fechaTexto [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 | Page(title='Inicio', url='/') Section(title='Proyectos') Page(title='Brazo Robótico', url='/proyecto/SCARA/') Page(title='Plataforma Móvil', url='/proyecto/Zombie/') Page(title='EV3 Bluetooth', url='/proyecto/EV3-bluetooth/') Page(title='OpenCV con Python', url='/proyecto/OpenCV/') Section(title='Anteriores') Page(title='Robot Delta', url='/proyecto/Delta/') Page(title='EV3 Micropython', url='/proyecto/EV3-micropython/') Page(title='PaCo', url='/proyecto/paco/') Section(title='Recursos') Page(title='Ofertas de Trabajo', url='/recurso/trabajo/') Page(title='Laboratorios', url='/recurso/laboratorios/') Page(title='Python', url='/recurso/python/') Page(title='ROS', url='/recurso/ros/') Page(title='Markdown', url='/recurso/markdown/') Page(title='Github Desktop', url='/recurso/github-desktop/') Section(title='Tutoriales') Page(title='Instalar Ubuntu en USB', url='/tutorial/ubuntu/') Section(title='Linux') Page(title='Comandos de Linux', url='/tutorial/linux/') Page(title='Editor VI', url='/tutorial/linux/vi/') Page(title='bash', url='/tutorial/linux/bash/') Page(title='Cpp', url='/tutorial/C%2B%2B/') Page(title='WSL', url='/tutorial/WSL/') Section(title='ROS2') Page(title='Introducción', url='/tutorial/ROS2/') Page(title='ROS2 con Python', url='/tutorial/ROS2/ROS2PY/') Page(title='Nav2', url='/tutorial/nav2/') Section(title='Electrónica') Page(title='Introducción', url='/tutorial/electronica/') Page(title='Divisor de Tensión', url='/tutorial/electronica/divisor-tension/') Page(title='Suiches', url='/tutorial/electronica/suiche/') Page(title='LED', url='/tutorial/electronica/led/') Page(title='Semiconductores', url='/tutorial/electronica/semiconductor/') Section(title='Semillero') Page(title='Actas', url='/acta/') Page(title='Contacto', url='/contacto/') Link(title='Inscripción', url='https://forms.office.com/r/ckjAxv6n1n') Page(title='Miembros', url='/miembro/') Link(title='Canal YouTube', url='https://www.youtube.com/channel/UCnFF6O1mzq8r9tDKErtZGTA?sub_confirmation=1') Page(title='Description (en)', url='/en/') |
files | Files | |
page | Page | Page(title='Macros', url='/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 | '/builds/davinsony/ares/mkdocs.yml' |
site_name | str | 'Semillero ARES' |
nav | list | [{'Inicio': 'index.md'}, {'Proyectos': [{'Brazo Robótico': 'proyecto/SCARA/index.md'}, {'Plataforma Móvil': 'proyecto/Zombie/index.md'}, {'EV3 Bluetooth': 'proyecto/EV3-bluetooth/index.md'}, {'OpenCV con Python': 'proyecto/OpenCV/index.md'}, {'Anteriores': [{'Robot Delta': 'proyecto/Delta/index.md'}, {'EV3 Micropython': 'proyecto/EV3-micropython/index.md'}, {'PaCo': 'proyecto/paco/index.md'}]}]}, {'Recursos': [{'Ofertas de Trabajo': 'recurso/trabajo.md'}, {'Laboratorios': 'recurso/laboratorios.md'}, {'Python': 'recurso/python.md'}, {'ROS': 'recurso/ros.md'}, {'Markdown': 'recurso/markdown.md'}, {'Github Desktop': 'recurso/github-desktop.md'}]}, {'Tutoriales': [{'Instalar Ubuntu en USB': 'tutorial/ubuntu/index.md'}, {'Linux': [{'Comandos de Linux': 'tutorial/linux/index.md'}, {'Editor VI': 'tutorial/linux/vi.md'}, {'bash': 'tutorial/linux/bash.md'}]}, {'Cpp': 'tutorial/C++/index.md'}, {'WSL': 'tutorial/WSL/index.md'}, {'ROS2': [{'Introducción': 'tutorial/ROS2/index.md'}, {'ROS2 con Python': 'tutorial/ROS2/ROS2PY.md'}]}, {'Nav2': 'tutorial/nav2/index.md'}, {'Electrónica': [{'Introducción': 'tutorial/electronica/index.md'}, {'Divisor de Tensión': 'tutorial/electronica/divisor-tension.md'}, {'Suiches': 'tutorial/electronica/suiche.md'}, {'LED': 'tutorial/electronica/led.md'}, {'Semiconductores': 'tutorial/electronica/semiconductor.md'}]}]}, {'Semillero': [{'Actas': 'acta/index.md'}, {'Contacto': 'contacto.md'}, {'Inscripción': 'https://forms.office.com/r/ckjAxv6n1n'}, {'Miembros': 'miembro/index.md'}, {'Canal YouTube': 'https://www.youtube.com/channel/UCnFF6O1mzq8r9tDKErtZGTA?sub_confirmation=1'}, {'Description (en)': 'en.md'}]}] |
pages | NoneType | None |
site_url | str | 'https://ares.davinsony.com/' |
site_description | NoneType | None |
site_author | str | 'Davinson Castaño' |
theme | Theme | Theme(name='mkdocs', dirs=['/builds/davinsony/ares/theme/', '/usr/local/lib/python3.11/site-packages/mkdocs/themes/mkdocs', '/usr/local/lib/python3.11/site-packages/mkdocs/templates', '/usr/local/lib/python3.11/site-packages/mkdocs/contrib/search/templates'], static_templates=['404.html', 'sitemap.xml'], name='mkdocs', locale=Locale(language='es', territory=''), include_search_page=False, search_index_only=False, highlightjs=True, hljs_languages=[], hljs_style='github', navigation_depth=2, nav_style='primary', analytics={'gtag': 'G-JK3EXWH3B4'}, shortcuts={'help': 191, 'next': 78, 'previous': 80, 'search': 83}) |
docs_dir | str | '/builds/davinsony/ares/docs' |
site_dir | str | '/builds/davinsony/ares/public' |
copyright | str | 'Copyright © 2019-2023 Davinson Castaño. Contenido creado por los estudiantes del Semillero.' |
google_analytics | NoneType | None |
dev_addr | _IpAddressValue | _IpAddressValue(host='127.0.0.1', port=8000) |
use_directory_urls | bool | True |
repo_url | NoneType | None |
repo_name | NoneType | None |
edit_uri_template | NoneType | None |
edit_uri | NoneType | None |
extra_css | list | ['css/extra.css'] |
extra_javascript | list | ['https://polyfill.io/v3/polyfill.min.js?features=es6', 'https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js', 'js/mathjax.js', 'js/https.js', 'search/main.js'] |
extra_templates | list | [] |
markdown_extensions | list | ['toc', 'tables', 'fenced_code', 'admonition', 'attr_list', 'codehilite', 'def_list', 'sane_lists'] |
mdx_configs | dict | toc [dict] |
strict | bool | False |
remote_branch | str | 'gh-pages' |
remote_name | str | 'origin' |
extra | LegacyConfig | {} |
plugins | PluginCollection | search [SearchPlugin], macros [MacrosPlugin] |
hooks | dict | |
watch | list | ['/builds/davinsony/ares/data'] |
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 |
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'). |
ls | function | (relative) Lista los archivos en el directorio actual |
fechaTexto | function | (fecha, meses, date) Crea la ficha para las actas |
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(2023, 4, 20, 11, 53, 35, tzinfo=tzoffset(None, -18000)) |
short_commit | str | '5bf1952' |
commit | str | '5bf1952db5d90ce40dcba50c5752687265755e0a' |
tag | str | '' |
author | str | 'Davinson CASTANO' |
author_email | str | '[email protected]' |
committer | str | 'Davinson CASTANO' |
committer_email | str | '[email protected]' |
date_ISO | str | 'Thu Apr 20 11:53:35 2023 -0500' |
message | str | 'acta de 20 de abril' |
raw | str | 'commit 5bf1952db5d90ce40dcba50c5752687265755e0a\nAuthor: Davinson CASTANO |
root_dir | str | '/builds/davinsony/ares' |
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 | File | page [Page], src_uri = 'macros.md', abs_src_path = '/builds/davinsony/ares/docs/macros.md', name = 'macros', dest_uri = 'macros/index.html', abs_dest_path = '/builds/davinsony/ares/public/macros/index.html', url = 'macros/' |
title | str | 'Macros' |
parent | NoneType | None |
children | NoneType | None |
previous_page | NoneType | None |
next_page | NoneType | None |
_Page__active | bool | False |
update_date | str | '2023-04-20' |
canonical_url | str | 'https://ares.davinsony.com/macros/' |
abs_url | str | '/macros/' |
edit_url | NoneType | None |
markdown | str | '{{ 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. |
batch | function | (value, linecount, fill_with, tmp, item) A filter that batches items. It works pretty much like |
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 |
escape | builtin_function_or_method | Replace the characters |
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 |
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 |
forceescape | function | (value) Enforce HTML escaping. This will probably double escape variables. |
format | function | (value, args, kwargs) Apply the given values to a |
groupby | function | (args, kwargs, b) Group a sequence of objects by an attribute using Python's :func: |
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 |
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 |
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 |
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 |
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: |
string | builtin_function_or_method | Convert an object to a string if it isn't already. This preserves a :class: |
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 |
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 |
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. |