Skip to content

Setting up the footer

The footer of your project documentation is a great place to add links to websites or platforms you or your company are using as additional marketing channels, e.g. , or , which can be configured via mkdocs.yml.

Configuration

1.0.0 · Default: none

Social links are rendered next to the copyright notice as part of the footer of your project documentation. Add a list of social links in mkdocs.yml with:

extra:
  social:
    - icon: fontawesome/brands/twitter # (1)!
      link: https://twitter.com/squidfunk
  1. Enter a few keywords to find the perfect icon using our [icon search] and click on the shortcode to copy it to your clipboard:

    The following properties must be set for each link:

    icon

    5.0.0 · Default: none · Required – This property must contain a valid path to any icon bundled with the theme, or the build will not succeed. Some popular choices:

    • fontawesome/brands/behance
    • fontawesome/brands/docker
    • fontawesome/brands/github
    • fontawesome/brands/instagram
    • fontawesome/brands/linkedin
    • fontawesome/brands/medium
    • fontawesome/brands/pied-piper-alt
    • fontawesome/brands/product-hunt
    • fontawesome/brands/slack
    • fontawesome/brands/twitter
    link

    Default: none · Required – This property must be set to a relative or absolute URL including the URI scheme. All URI schemes are supported, including mailto and bitcoin:

    extra:
      social:
        - icon: fontawesome/brands/twitter
          link: https://twitter.com/squidfunk
    
    extra:
      social:
        - icon: fontawesome/solid/paper-plane
          link: mailto:<email-address>
    
    name

    5.1.5 · Default: domain name from link, if available – This property is used as the link's title attribute and can be set to a discernable name to improve accessibility:

    extra:
      social:
        - icon: fontawesome/brands/twitter
          link: https://twitter.com/squidfunk
          name: squidfunk on Twitter
    

    0.1.0 · Default: none

    A custom copyright banner can be rendered as part of the footer, which is displayed next to the social links. It can be defined as part of mkdocs.yml:

    copyright: Copyright &copy; 2016 - 2020 Martin Donath
    

    Generator notice

    7.3.0 · Default: true

    The footer displays a Made with Material for MkDocs notice to denote how the site was generated. The notice can be removed with the following option via mkdocs.yml:

    extra:
      generator: false
    

    Please read this before removing the generator notice

    The subtle Made with Material for MkDocs hint in the footer is one of the reasons why this project is so popular, as it tells the user how the site is generated, helping new users to discover this project. Before removing please consider that you're enjoying the benefits of @squidfunk's work for free, as this project is Open Source and has a permissive license. Thousands of hours went into this project, most of them without any financial return.

    Thus, if you remove this notice, please consider sponsoring the project. Thank you

    Customization

    8.0.0 · Customization

    In order to customize and override the copyright notice, extend the theme and override the copyright block, which is normally set to the copyright property set in mkdocs.yml:

    {% extends "base.html" %}
    
    {% block copyright %}
      <!-- Add copyright here, including arbitrary HTML -->
    {% endblock %}
    
    Back to top