OpenSourceArk/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-06-14 11:52:32 +03:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #2375 from polarathene/docs/setup-logo-clarify

Browse Source 
docs: Better clarify logo setup options
This commit is contained in:
Martin Donath 2021-03-07 15:25:55 +01:00 committed by GitHub
commit f14a96020b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
docs/setup/changing-the-logo-and-icons.md
View File

@ -16,11 +16,19 @@ additional icons][1] with minimal effort.
### Logo
[:octicons-file-code-24: Source][2] ·
:octicons-milestone-24: Default: `material/library`
:octicons-milestone-24: Default: [`material/library`](https://github.com/squidfunk/mkdocs-material/blob/master/material/.icons/material/library.svg)
There're two ways to specify a _logo_: it must be a valid path to [any icon
bundled with the theme][3], or to a user-provided image located in the `docs`
folder. Both can be set via `mkdocs.yml`:
Configured in your `mkdocs.yml`; there are two types of _logo_ (choose only one):
- `theme.logo` a user-provided image (_supports SVG_) located in the `docs` folder.
- `theme.icon.logo` for using [any icon bundled with the theme][3].
=== "Image"
``` yaml
theme:
logo: assets/logo.png
```
=== "Icon"
@ -30,13 +38,6 @@ folder. Both can be set via `mkdocs.yml`:
logo: material/library
```
=== "Image"
``` yaml
theme:
logo: assets/logo.png
```
[2]: https://github.com/squidfunk/mkdocs-material/blob/master/src/partials/logo.html
[3]: https://github.com/squidfunk/mkdocs-material/tree/master/material/.icons