5.2 KiB
template |
---|
overrides/main.html |
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-medium:{ style="color: #00AB6C" },
:fontawesome-brands-twitter:{ style="color: #1DA1F2" } or
:fontawesome-brands-facebook:{ style="color: #4267B2" }, which can be
configured via mkdocs.yml
.
Configuration
Social links
:octicons-hash-24: Setting · :octicons-milestone-24: Default: none · :octicons-tag-24: 1.0.0
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
link: https://twitter.com/squidfunk
For each entry, the following settings are available:
icon
{ #social-icon }-
:octicons-milestone-24: Default: none · :octicons-alert-24: 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/behance
- :fontawesome-brands-docker: –
fontawesome/brands/docker
- :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
- :fontawesome-brands-behance: –
link
{ #social-link }-
:octicons-milestone-24: Default: none · :octicons-alert-24: Required – This field must contain a valid relative or absolute URL including the URI scheme. All URI schemes are supported, including
mailto
andbitcoin
:=== "Twitter"
``` yaml extra: social: - icon: fontawesome/brands/twitter link: https://twitter.com/squidfunk ```
=== "Email address"
``` 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 field is used as the link'stitle
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
Copyright notice
:octicons-hash-24: Setting · :octicons-milestone-24: Default: none · :octicons-tag-24: 0.1.0
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
:octicons-hash-24: Setting ·
:octicons-milestone-24: Default: true
·
:octicons-tag-24: 7.3.0
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
!!! 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 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][4] the project. __Thank you__
:octicons-heart-fill-24:{ .mdx-heart .mdx-insiders }
Customization
Custom icons
:octicons-file-code-24: Source · :octicons-mortar-board-24: 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.