Built-in Context

environment: dict = {
    'system': str,           # Operating system name ('Linux', 'Windows', 'MacOs')
    'system_version': str,   # OS version string
    'python_version': str,   # Python version string
    'mkdocs_version': str,   # MkDocs version
    'macros_plugin_version': str,  # Plugin version
    'jinja2_version': str    # Jinja2 version
}

Running on {{ environment.system }} {{ environment.system_version }}
Built with Python {{ environment.python_version }}

{% if environment.system == 'Windows' %}
Use `copy` command instead of `cp`.
{% else %}
Use standard Unix commands.
{% endif %}

Documentation built with:
- MkDocs {{ environment.mkdocs_version }}
- MkDocs Macros {{ environment.macros_plugin_version }}
- Python {{ environment.python_version }}

plugin: dict  # Complete plugin configuration from mkdocs.yml macros section

{% if plugin.verbose %}
Debug mode is enabled.
{% endif %}

Module name: {{ plugin.module_name }}

{% if plugin.include_dir %}
Templates loaded from: {{ plugin.include_dir }}
{% endif %}

git: dict = {
    'status': bool,          # True if git information was successfully retrieved
    'commit': str,           # Full commit hash
    'short_commit': str,     # Abbreviated commit hash
    'tag': str,              # Current git tag (if any)
    'short_tag': str,        # Tag without version suffix
    'author': str,           # Last commit author name
    'author_email': str,     # Last commit author email
    'committer': str,        # Last commit committer name
    'committer_email': str,  # Last commit committer email
    'date': datetime,        # Last commit date as datetime object
    'date_ISO': str,         # Last commit date as ISO string
    'message': str,          # Last commit message
    'raw': str,              # Raw git log output
    'root_dir': str          # Git repository root directory
}

Last updated: {{ git.date.strftime('%Y-%m-%d') }}
Commit: {{ git.short_commit }}

{% if git.tag %}
Version: {{ git.short_tag }}
{% endif %}

{% if git.status %}
Repository: {{ git.root_dir }}
Author: {{ git.author }}
{% else %}
Not a git repository
{% endif %}

---
Built from commit [{{ git.short_commit }}]({{ config.repo_url }}/commit/{{ git.commit }})
on {{ git.date.strftime('%B %d, %Y') }}
---

config: dict  # Complete mkdocs.yml configuration

# {{ config.site_name }}

{{ config.site_description }}

{% if config.site_url %}
Visit us at: {{ config.site_url }}
{% endif %}

{% if config.repo_url %}
Source code: [{{ config.repo_name }}]({{ config.repo_url }})
{% endif %}

{% if config.theme.name == 'material' %}
Using Material theme with features:
{% for feature in config.theme.features %}
- {{ feature }}
{% endfor %}
{% endif %}

Active plugins:
{% for plugin in config.plugins %}
- {{ plugin }}
{% endfor %}

extra: dict  # Variables from mkdocs.yml extra section
# Also available as top-level variables

extra:
  version: '2.1.0'
  author: 'John Doe'
  social:
    twitter: '@johndoe'
    github: 'johndoe'

Version: {{ version }} <!-- or {{ extra.version }} -->
Author: {{ author }}

Follow us:
- [Twitter](https://twitter.com/{{ social.twitter }})
- [GitHub](https://github.com/{{ social.github }})

page: Page = {
    'title': str,           # Page title
    'url': str,             # Page URL
    'abs_url': str,         # Absolute page URL
    'canonical_url': str,   # Canonical URL
    'edit_url': str,        # Edit URL (if configured)
    'file': File,           # File object with path information
    'content': str,         # Rendered page content (HTML)
    'toc': list,            # Table of contents
    'meta': dict,           # Page metadata from YAML front matter
    'previous_page': Page,  # Previous page in navigation
    'next_page': Page       # Next page in navigation
}

# {{ page.title }}

{% if page.meta.description %}
{{ page.meta.description }}
{% endif %}

File: `{{ page.file.src_path }}`

{% if page.edit_url %}
[Edit this page]({{ page.edit_url }})
{% endif %}

{% if page.previous_page %}
← [{{ page.previous_page.title }}]({{ page.previous_page.url }})
{% endif %}

{% if page.next_page %}
[{{ page.next_page.title }}]({{ page.next_page.url }}) →
{% endif %}

{% if page.file.src_path.startswith('api/') %}
This is an API documentation page.
{% endif %}

{% if 'draft' in page.meta %}
⚠️ This page is a draft
{% endif %}

navigation: Navigation  # Site navigation object with pages and hierarchy

## Site Contents

{% for item in navigation.items %}
{% if item.is_page %}
- [{{ item.title }}]({{ item.url }})
{% elif item.is_section %}
- {{ item.title }}
  {% for child in item.children %}
  - [{{ child.title }}]({{ child.url }})
  {% endfor %}
{% endif %}
{% endfor %}

This site contains {{ navigation.pages | length }} pages.

files: Files  # Collection of all site files

## All Files

{% for file in files %}
- {{ file.src_path }} → {{ file.dest_path }}
{% endfor %}

{% for file in files %}
{% if file.name == 'changelog.md' %}
{% include file.src_path %}
{% endif %}
{% endfor %}

<!-- Dot notation -->
{{ config.theme.name }}
{{ git.date.year }}
{{ page.file.src_path }}

<!-- Bracket notation -->
{{ config['site_name'] }}
{{ environment['python_version'] }}

<!-- With defaults -->
{{ config.repo_name | default('Unknown Repository') }}