{% if favicon %} {% else %} {% endif %} {% for path in extra_css %} {% endfor %} {% for path in extra_javascript %} {% endfor %} {% if google_analytics %} {% endif %} {% block extrahead %} {% endblock %}

This is an example theme for MkDocs.

It is designed to be read by looking at the theme HTML which is heavily commented. The easiest way to do that is by looking at the source on GitHub.. Otherwise this is just a demonstration that the theme is fully functional.


Documentation Navigation


Support for search


Next and previous links

{% if next_page or previous_page %}
{% if previous_page %} ← Previous Page {% else %} ← Previous Page {% endif %} - {% if next_page %} Next Page → {% else %} Next Page → {% endif %}
{% endif %}

Link to the source

{% if repo_url %} {% if repo_name == 'GitHub' %} Edit on GitHub {% elif repo_name == 'Bitbucket' %} Edit on BitBucket {% else %} Edit in Repository {% endif %} {% endif %}

Show the table of contents for the current page


{% block content %} {{ content }} {% endblock %}