Skip to content

Latest commit

 

History

History
175 lines (130 loc) · 6.03 KB

setting-up-the-footer.md

File metadata and controls

175 lines (130 loc) · 6.03 KB
Raw

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. :fontawesome-brands-twitter:{ style="color: #1DA1F2" } or :fontawesome-brands-youtube:{ style="color: #EE0F0F" }, which you can easily configure via mkdocs.yml.

Configuration

Social links

:octicons-tag-24: 1.0.0 · :octicons-milestone-24: 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 are available for each link:

    icon{ #+social.icon }

    : :octicons-milestone-24: Default: none · :octicons-alert-24: 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-docker: – `fontawesome/brands/docker`
* :fontawesome-brands-facebook: – `fontawesome/brands/facebook`
* :fontawesome-brands-github: – `fontawesome/brands/github`
* :fontawesome-brands-instagram: – `fontawesome/brands/instagram`
* :fontawesome-brands-linkedin: – `fontawesome/brands/linkedin`
* :fontawesome-brands-medium: – `fontawesome/brands/medium`
* :fontawesome-brands-pied-piper-alt: – `fontawesome/brands/pied-piper-alt`
* :fontawesome-brands-product-hunt: – `fontawesome/brands/product-hunt`
* :fontawesome-brands-slack: – `fontawesome/brands/slack`
* :fontawesome-brands-twitter: – `fontawesome/brands/twitter`

    link{ #+social.link }

    : :octicons-milestone-24: Default: none · :octicons-alert-24: 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:

    === ":fontawesome-brands-twitter: Twitter"

    ``` yaml
    extra:
      social:
        - icon: fontawesome/brands/twitter
          link: https://twitter.com/squidfunk
    ```

=== ":octicons-mail-16: Email"

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

    name{ #+social.name }

    : :octicons-milestone-24: 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:

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

    Copyright notice

    :octicons-tag-24: 0.1.0 · :octicons-milestone-24: 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

    :octicons-tag-24: 7.3.0 · :octicons-milestone-24: 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

    !!! info "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][Insiders] the
project. __Thank you__ :octicons-heart-fill-24:{ .mdx-heart .mdx-insiders }

    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

    :octicons-tag-24: 8.0.0 · :octicons-file-symlink-file-24: 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.