mirror of
https://github.com/squidfunk/mkdocs-material.git
synced 2024-06-14 11:52:32 +03:00
Added notes on icon logo to documentation
This commit is contained in:
squidfunk
Martin Donath
parent
60d3a49aed
commit
43484824ee
@ -303,10 +303,21 @@ extra:
|
||||
logo: 'images/logo.svg'
|
||||
```
|
||||
|
||||
Additionally, the default icon can be changed by setting an arbitrary ligature
|
||||
(or Unicode code point) from the [Material Design icon font][16], e.g.
|
||||
|
||||
``` yaml
|
||||
extra:
|
||||
logo:
|
||||
icon: 'cloud'
|
||||
```
|
||||
|
||||
[16]: https://material.io/icons/
|
||||
|
||||
### Adding social links
|
||||
|
||||
Social accounts can be linked in the footer of the documentation using the
|
||||
automatically included [FontAwesome][16] webfont. The `type` must denote the
|
||||
automatically included [FontAwesome][17] webfont. The `type` must denote the
|
||||
name of the social service, e.g. `github`, `twitter` or `linkedin` and the
|
||||
`link` must contain the URL you want to link to:
|
||||
|
||||
@ -325,7 +336,7 @@ The links are generated in order and the `type` of the links must match the
|
||||
name of the FontAwesome glyph. The `fa` is automatically added, so `github`
|
||||
will result in `fa fa-github`.
|
||||
|
||||
[16]: http://fontawesome.io/icons/
|
||||
[17]: http://fontawesome.io/icons/
|
||||
|
||||
### Google Analytics integration
|
||||
|
||||
@ -342,7 +353,7 @@ google_analytics:
|
||||
|
||||
### Disqus integation
|
||||
|
||||
Material for MkDocs is integrated with [Disqus][17], so if you want to add a
|
||||
Material for MkDocs is integrated with [Disqus][18], so if you want to add a
|
||||
comments section to your documentation set the shortname of your Disqus project
|
||||
in your `mkdocs.yml`:
|
||||
|
||||
@ -361,7 +372,7 @@ automatically included.
|
||||
`site_url` value must be set in `mkdocs.yml` for the Disqus integration to
|
||||
load properly.
|
||||
|
||||
[17]: https://disqus.com
|
||||
[18]: https://disqus.com
|
||||
|
||||
### Localization
|
||||
|
||||
@ -393,19 +404,19 @@ macro `t`:
|
||||
```
|
||||
|
||||
Just copy the file from the original theme and make your adjustments. See the
|
||||
section on [overriding partials][18] and the general guide on
|
||||
[theme extension][19] in the customization guide. Furthermore, see the
|
||||
[example configuration][20] for a head start.
|
||||
section on [overriding partials][19] and the general guide on
|
||||
[theme extension][20] in the customization guide. Furthermore, see the
|
||||
[example configuration][21] for a head start.
|
||||
|
||||
[18]: customization.md#overriding-partials
|
||||
[19]: customization.md#extending-the-theme
|
||||
[20]: https://github.com/squidfunk/mkdocs-material/tree/master/examples/language
|
||||
[19]: customization.md#overriding-partials
|
||||
[20]: customization.md#extending-the-theme
|
||||
[21]: https://github.com/squidfunk/mkdocs-material/tree/master/examples/language
|
||||
|
||||
#### Site search
|
||||
|
||||
Site search is implemented using [lunr.js][21], which includes stemmers for the
|
||||
Site search is implemented using [lunr.js][22], which includes stemmers for the
|
||||
English language by default, while stemmers for other languages are included
|
||||
with [lunr-languages][22], both of which are integrated with this theme. Support
|
||||
with [lunr-languages][23], both of which are integrated with this theme. Support
|
||||
for other languages and even multilingual search can be activated by setting
|
||||
the key `search.languages` to a comma-separated list of supported 2-letter
|
||||
language codes, e.g.:
|
||||
@ -443,8 +454,8 @@ to index parts of words that are separated by `-` or `.` for example:
|
||||
}[key] }}{% endmacro %}
|
||||
```
|
||||
|
||||
[21]: https://lunrjs.com
|
||||
[22]: https://github.com/MihaiValentin/lunr-languages
|
||||
[22]: https://lunrjs.com
|
||||
[23]: https://github.com/MihaiValentin/lunr-languages
|
||||
|
||||
### Tabs
|
||||
|
||||
@ -462,13 +473,13 @@ extra:
|
||||
### More advanced customization
|
||||
|
||||
If you want to change the general appearance of the Material theme, see
|
||||
[this article][23] for more information on advanced customization.
|
||||
[this article][24] for more information on advanced customization.
|
||||
|
||||
[23]: customization.md
|
||||
[24]: customization.md
|
||||
|
||||
## Extensions
|
||||
|
||||
MkDocs supports several [Markdown extensions][24]. The following extensions
|
||||
MkDocs supports several [Markdown extensions][25]. The following extensions
|
||||
are not enabled by default (see the link for which are enabled by default)
|
||||
but highly recommended, so they should be switched on at all times:
|
||||
|
||||
@ -482,20 +493,20 @@ markdown_extensions:
|
||||
For more information, see the following list of extensions supported by the
|
||||
Material theme including more information regarding installation and usage:
|
||||
|
||||
* [Admonition][25]
|
||||
* [Codehilite][26]
|
||||
* [Footnotes][27]
|
||||
* [Metadata][28]
|
||||
* [Permalinks][29]
|
||||
* [PyMdown Extensions][30]
|
||||
* [Admonition][26]
|
||||
* [Codehilite][27]
|
||||
* [Footnotes][28]
|
||||
* [Metadata][29]
|
||||
* [Permalinks][30]
|
||||
* [PyMdown Extensions][31]
|
||||
|
||||
[24]: http://www.mkdocs.org/user-guide/writing-your-docs/#markdown-extensions
|
||||
[25]: extensions/admonition.md
|
||||
[26]: extensions/codehilite.md
|
||||
[27]: extensions/footnotes.md
|
||||
[28]: extensions/metadata.md
|
||||
[29]: extensions/permalinks.md
|
||||
[30]: extensions/pymdown.md
|
||||
[25]: http://www.mkdocs.org/user-guide/writing-your-docs/#markdown-extensions
|
||||
[26]: extensions/admonition.md
|
||||
[27]: extensions/codehilite.md
|
||||
[28]: extensions/footnotes.md
|
||||
[29]: extensions/metadata.md
|
||||
[30]: extensions/permalinks.md
|
||||
[31]: extensions/pymdown.md
|
||||
|
||||
## Full example
|
||||
|
||||
|
||||
17
yarn.lock
17
yarn.lock
@ -1993,9 +1993,9 @@ flatten@^1.0.2:
|
||||
version "1.0.2"
|
||||
resolved "https://registry.yarnpkg.com/flatten/-/flatten-1.0.2.tgz#dae46a9d78fbe25292258cc1e780a41d95c03782"
|
||||
|
||||
flow-bin@^0.53.0:
|
||||
version "0.53.1"
|
||||
resolved "https://registry.yarnpkg.com/flow-bin/-/flow-bin-0.53.1.tgz#9b22b63a23c99763ae533ebbab07f88c88c97d84"
|
||||
flow-bin@^0.54.0:
|
||||
version "0.54.0"
|
||||
resolved "https://registry.yarnpkg.com/flow-bin/-/flow-bin-0.54.0.tgz#f2fb0478e9e99702b623c9ed84079a39903bba77"
|
||||
|
||||
flow-jsdoc@^0.3.0:
|
||||
version "0.3.0"
|
||||
@ -2474,15 +2474,16 @@ gulp-sourcemaps@^2.6.0:
|
||||
through2 "2.X"
|
||||
vinyl "1.X"
|
||||
|
||||
gulp-stylelint@^4.0.0:
|
||||
version "4.0.0"
|
||||
resolved "https://registry.yarnpkg.com/gulp-stylelint/-/gulp-stylelint-4.0.0.tgz#440fa7e6c447e92644700e1e2a06a73e6e457750"
|
||||
gulp-stylelint@^5.0.0:
|
||||
version "5.0.0"
|
||||
resolved "https://registry.yarnpkg.com/gulp-stylelint/-/gulp-stylelint-5.0.0.tgz#c507f5e314602e7122eff599f2880eb0b62657b0"
|
||||
dependencies:
|
||||
chalk "^2.0.1"
|
||||
deep-extend "^0.5.0"
|
||||
gulp-util "^3.0.8"
|
||||
mkdirp "^0.5.1"
|
||||
promise "^8.0.1"
|
||||
source-map "^0.5.6"
|
||||
strip-ansi "^4.0.0"
|
||||
stylelint "^8.0.0"
|
||||
through2 "^2.0.3"
|
||||
@ -5604,7 +5605,7 @@ vinyl@^0.5.0:
|
||||
clone-stats "^0.0.1"
|
||||
replace-ext "0.0.1"
|
||||
|
||||
vinyl@^2.0.0, vinyl@^2.0.1:
|
||||
vinyl@^2.0.0:
|
||||
version "2.0.1"
|
||||
resolved "https://registry.yarnpkg.com/vinyl/-/vinyl-2.0.1.tgz#1c3b4931e7ac4c1efee743f3b91a74c094407bb6"
|
||||
dependencies:
|
||||
@ -5616,7 +5617,7 @@ vinyl@^2.0.0, vinyl@^2.0.1:
|
||||
remove-trailing-separator "^1.0.1"
|
||||
replace-ext "^1.0.0"
|
||||
|
||||
vinyl@^2.1.0:
|
||||
vinyl@^2.0.1, vinyl@^2.1.0:
|
||||
version "2.1.0"
|
||||
resolved "https://registry.yarnpkg.com/vinyl/-/vinyl-2.1.0.tgz#021f9c2cf951d6b939943c89eb5ee5add4fd924c"
|
||||
dependencies:
|
||||
|
||||
Loading…
Reference in New Issue
Block a user