Mkdocs-material: Exception when setting only logo icon in 5.0.0rc1

Created on 11 Mar 2020  路  4Comments  路  Source: squidfunk/mkdocs-material

__I checked that...__

  • [x] ... the documentation does not mention anything about my problem
  • [x] ... the problem doesn't occur with the default MkDocs template
  • [x] ... the problem is not in any of my customizations (CSS, JS, template)
  • [x] ... there are no open or closed issues that are related to my problem

Description

In the configuration, when specifying a custom icon as logo, but not a custom repo icon, a jinja2.exceptions.TemplateNotFound is raised.

Expected behavior

The logo icon should be set, and the repo icon should fallback to the default.

Actual behavior

A jinja2.exceptions.TemplateNotFound is raised. As a workaround, we can set the repo icon the configuration.

Steps to reproduce the bug

  1. Start a mkdocs-material project
  2. Set this in the theme configuration:
theme:
  name: 'material'
  icon:
    logo: fontawesome/solid/microphone
  1. Run mkdocs serve

Package versions

  • Python: 3.7.5
  • MkDocs: 1.1
  • Material: 5.0.0rc1

Project configuration

site_name: FastAPI Users
site_description: Ready-to-use and customizable users management for FastAPI

theme:
  name: 'material'
  palette:
    primary: 'red'
    accent: 'red'
  icon:
    logo: fontawesome/solid/microphone
  favicon: 'favicon.png'

repo_name: frankie567/fastapi-users
repo_url: https://github.com/frankie567/fastapi-users
edit_uri: ""

markdown_extensions:
  - markdown_include.include:
      base_path: docs
  - toc:
      permalink: true
  - admonition
  - codehilite
  - pymdownx.superfences
  - pymdownx.tasklist

System information

  • OS: macOS 10.15.2
  • Browser: Chrome 80
bug

All 4 comments

Confirmed, thanks for reporting!

Fixed in fcbd47c2, will be part of RC 2. We'll wait for some more feedback before the next RC, as this is a minor bug with a simple workaround for the time being.

That's great! Thanks @squidfunk 馃憤

Just released RC 2. Please re-open if the issue persists.

Was this page helpful?
0 / 5 - 0 ratings