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

Source · Default: none

All social links are rendered next to the copyright information 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
      link: https://twitter.com/squidfunk

For each entry, the following fields are available:

icon

Default: none · Required – This field must point to a valid icon path referencing 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 field must contain a valid 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

Default: domain name from link, if available – This field 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

Source · 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

Remove generator

Source

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 setting 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 it, 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

Custom icons

Source · Difficulty: easy

The social links feature uses the standard icon integration of Material for MkDocs. If you want to use custom icons, follow the guide explaining how to add additional icons.

Back to top