From 2d144f0407d5f2caf02e813b92e7c73ddca91e44 Mon Sep 17 00:00:00 2001 From: Brennan Kinney <5098581+polarathene@users.noreply.github.com> Date: Tue, 2 Mar 2021 10:54:19 +1300 Subject: [PATCH] docs: Better clarify logo setup options Better clarifies the distinct path difference (as they share a very similar but slightly different path), which can be accidentally missed triggering either an unhelpful "error" message to the console: `.icons/.svg`. Additionally switches the order of the tabs to the more common implicit use-case of providing a logo resource vs a more explicit decision to use a bundled theme SVG icon for a logo (which is handled differently compared to `theme.logo` such as scaling). --- docs/setup/changing-the-logo-and-icons.md | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/docs/setup/changing-the-logo-and-icons.md b/docs/setup/changing-the-logo-and-icons.md index 22156a6d6..fd188c70d 100644 --- a/docs/setup/changing-the-logo-and-icons.md +++ b/docs/setup/changing-the-logo-and-icons.md @@ -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