starred/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2026-07-30 09:43:05 -04:00
Code Issues Packages Projects Releases Wiki Activity

Fixed #79: Modularized social links integration

Browse Source
This commit is contained in:
squidfunk
2017-01-04 20:16:12 +01:00
parent 0198e5e98e
commit 01054414c8
13 changed files with 63 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/customization.md
View File

@@ -102,6 +102,7 @@ The directory layout of the Material theme is as follows:
│ ├─ nav-item.html # Main navigation item
│ ├─ nav.html # Main navigation
│ ├─ search.html # Search box
│ ├─ social.html # Social links
│ ├─ source.html # Repository information
│ ├─ svgs.html # Inline SVG definitions
│ ├─ toc-item.html # Table of contents item
@@ -151,6 +152,7 @@ The Material theme provides the following template blocks:
| `site_meta` | Wraps the meta tags in the document head |
| `site_name` | Wraps the site name in the header bar |
| `site_nav` | Wraps the site navigation and table of contents |
| `social` | Wraps the social links in the footer |
| `styles` | Wraps the stylesheets (also extra sources) |
For more on this topic refer to the [MkDocs documentation][4]

12
docs/getting-started.md
View File

@@ -239,9 +239,9 @@ extra:
If you want to link your social accounts, the Material theme provides an easy
way for doing this in the footer of the documentation using the automatically
included [Socicon][8] webfont. The syntax is simple - the `type` denotes the
name of the social service, e.g. `github`, `twitter` or `linkedin` and the
`link`, well, resembles the link:
included [FontAwesome][8] webfont. The syntax is simple – the `type` denotes
the name of the social service, e.g. `github`, `twitter` or `linkedin` and
the `link`, well, resembles the link:
``` yaml
extra:
@@ -254,9 +254,11 @@ extra:
link: 'https://de.linkedin.com/in/martin-donath-20a95039'
```
The links are generated in order.
The links are generated in order and the type of the link must match the name
of the FontAwesome glyph. The `fa` is automatically added, so `github` will
result in `fa fa-github`.
[8]: http://www.socicon.com/chart.php
[8]: http://fontawesome.io/icons/
### Google Analytics integration