mirror of
https://github.com/squidfunk/mkdocs-material.git
synced 2024-09-24 19:38:27 +02:00
89 lines
3.0 KiB
Markdown
89 lines
3.0 KiB
Markdown
|
---
|
|||
|
|
template: overrides/main.html
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
# Adding social links
|
|||
|
|
|
|||
|
|
The footer of your project documentation is a good 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: #3B5998" }, which can be
|
|||
|
|
configured through `mkdocs.yml`.
|
|||
|
|
|
|||
|
|
## Configuration
|
|||
|
|
|
|||
|
|
[:octicons-file-code-24: Source][1] ·
|
|||
|
|
:octicons-milestone-24: 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:
|
|||
|
|
|
|||
|
|
``` yaml
|
|||
|
|
extra:
|
|||
|
|
social:
|
|||
|
|
- icon: fontawesome/brands/twitter
|
|||
|
|
link: https://twitter.com/squidfunk
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
For each entry, the following fields are available:
|
|||
|
|
|
|||
|
|
`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][2], 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`
|
|||
|
|
|
|||
|
|
[1]: https://github.com/squidfunk/mkdocs-material/blob/master/src/partials/social.html
|
|||
|
|
[2]: https://github.com/squidfunk/mkdocs-material/tree/master/material/.icons
|
|||
|
|
|
|||
|
|
`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` and `bitcoin`:
|
|||
|
|
|
|||
|
|
=== "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:martin.donath@squidfunk.com
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
`name`
|
|||
|
|
|
|||
|
|
: :octicons-milestone-24: 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:
|
|||
|
|
|
|||
|
|
``` yaml
|
|||
|
|
extra:
|
|||
|
|
social:
|
|||
|
|
- icon: fontawesome/brands/twitter
|
|||
|
|
link: https://twitter.com/squidfunk
|
|||
|
|
name: squidfunk on Twitter
|
|||
|
|
```
|