Logo and icons¶

When installing Zensical, you immediately get access to over 10,000 icons ready to be used for customization of specific parts of the theme and when writing your documentation in Markdown. Not enough? You can also add additional icons with minimal effort.

Configuration¶

Logo¶

The logo can be changed to a user-provided image (any type, incl. *.png and *.svg) located in the docs folder, or to any icon bundled with the theme. Add the following lines to your configuration to set you own logo from an image file:

[project.theme]
logo = "assets/logo.png"

theme:
  logo: assets/logo.png

To set the logo to use one of the bundled icons, find a suitable icon and add it to the configuration:

[project.theme.icon]
logo = "lucide/smile"

theme:
  icon:
    logo: lucide/smile

Normally, the logo in the header and sidebar links to the homepage of the documentation, which is the same as site_url. This behavior can be changed with the following configuration:

[project.extra]
homepage = "https://example.com"

extra:
  homepage: https://example.com

Favicon¶

The favicon can be changed to a path pointing to a user-provided image, which must be located in the docs folder. Add the following lines to you configuration:

[project.theme]
favicon = "images/favicon.png"

theme:
  favicon: images/favicon.png

Site icons¶

Most icons you see on your site, such as navigation icons, can also be changed. For example, to change the navigation arrows in the footer, add the following lines to mkdocs.yml:

[project.theme.icon]
previous = "fontawesome/solid/angle-left"
next = "fontawesome/solid/angle-right"

theme:
  icon:
    previous: fontawesome/solid/angle-left
    next: fontawesome/solid/angle-right

The following is a complete list of customizable icons used by the theme:

Customization¶

Additional icons¶

In order to use custom icons, extend the theme and create a new folder named .icons in the custom_dir you want to use for overrides. Next, add your *.svg icons into a subfolder of the .icons folder. Let's say you downloaded and unpacked the Bootstrap icon set, and want to add it to your project documentation. The structure of your project should look like this:

.
├─ overrides/
│  └─ .icons/
│     └─ bootstrap/
│        └─ *.svg
└─ zensical.toml

[project.markdown_extensions.pymdownx.emoji]
emoji_index = "zensical.extensions.emoji.twemoji"
emoji_generator = "zensical.extensions.emoji.to_svg
options = {custom_icons = [overrides/.icons]}

.
├─ overrides/
│  └─ .icons/
│     └─ bootstrap/
│        └─ *.svg
└─ mkdocs.yml

markdown_extensions:
  - pymdownx.emoji:
      emoji_index: !!python/name:zensical.extensions.emoji.twemoji
      emoji_generator: !!python/name:zensical.extensions.emoji.to_svg
      options:
        custom_icons:
          - overrides/.icons

You can now use all Bootstrap icons anywhere in Markdown files, as well as everywhere icons can be used in your configuration. However, note that the syntaxes are slightly different:

• Use icons in configuration: take the path of the *.svg icon file starting at the .icons folder and drop the file extension, e.g. for .icons/bootstrap/envelope-paper.svg, use:

  zensical.tomlmkdocs.yml

  [project.theme.icon]
  logo = "bootstrap/envelope-paper"
  

  theme:
    icon:
      logo: bootstrap/envelope-paper
  

• Use icons in Markdown files: additionally to taking the path from the .icons folder as noted above, replace all / with - and enclose the icon shortcode in two colons:

  :bootstrap-envelope-paper:
  

For further notes on icon usage, please consult the icon reference.