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 you can easily configure via mkdocs.yml.

Configuration¶

Navigation¶

9.0.0 · Feature flag

The footer can include links to the previous and next page of the current page. If you wish to enable this behavior, add the following lines to mkdocs.yml:

theme:
  features:
    - navigation.footer

Social links¶

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/mastodon # (1)!
      link: https://fosstodon.org/@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 are available for each link:

icon

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/mastodon automatically adds rel=me
• – fontawesome/brands/twitter
• – fontawesome/brands/github
• – fontawesome/brands/docker
• – fontawesome/brands/facebook
• – fontawesome/brands/medium
• – fontawesome/brands/instagram
• – fontawesome/brands/linkedin
• – fontawesome/brands/pied-piper-alt
• – fontawesome/brands/slack

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:

Mastodon Email

extra:
  social:
    - icon: fontawesome/brands/mastodon
      link: https://fosstodon.org/@squidfunk

extra:
  social:
    - icon: fontawesome/solid/paper-plane
      link: mailto:<email-address>

name

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/mastodon
      link: https://fosstodon.org/@squidfunk
      name: squidfunk on Fosstodon

Copyright notice¶

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 © 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

Usage¶

Hiding prev/next links¶

The footer navigation showing links to the previous and next page can be hidden with the front matter hide property. Add the following lines at the top of a Markdown file:

---
hide:
  - footer
---

# Document title
...

Customization¶

Custom copyright¶

8.0.0 · Customization

In order to customize and override the copyright notice, extend the theme and override the copyright.html partial, which normally includes the copyright property set in mkdocs.yml.