Skip to content

Header and navigation sidebars display incorrectly arbitrary markup #3357

@Enn83

Description

@Enn83

Hello!

Since when does the bug occur?

I recently upgraded my mkdocs package from 1.4.2 to 1.5.2, and I noticed this bug when...

  • I don't specify a page title in mkdocs.yml file or in the page metadata (in yaml).
  • I use an emoji (HTML in general) in the first level section title in the markdown file:
# Intégration et Déploiement Continu sur :simple-gitlab: Gitlab

For example (with mkdocs-material theme and readthedocs theme):

263000285-555a71e9-3530-4a63-906a-17617c1d0be3
263459179-2afb6262-bde4-4727-b0e3-c5c4da035873

... while it was displayed like that before:

262992157-dcebad1a-82b1-445d-b250-8ef7aa34bafb

More generally, some parts like the search page of readthedocs theme don't handle well the HTML in title sections.

External links:

readthedocs theme pictures and bug explanations are from @squidfunk.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions