Skip to content

Annotations does not work with the theme feature navigation.instant #3685

Closed
@superhize

Description

@superhize

Contribution guidelines

  • I've read the contribution guidelines and wholeheartedly agree

I've found a bug and checked that ...

  • ... the problem doesn't occur with the mkdocs or readthedocs themes
    ... the problem persists when all overrides are removed, i.e. custom_dir, extra_javascript and extra_css
    ... the documentation does not mention anything about my problem
    ... there are no open or closed issues that are related to my problem

Description

Annotations (https://squidfunk.github.io/mkdocs-material/reference/annotations/) does not work when the theme feature navigation.instant is enabled.

Expected behaviour

Animations should work as it does in the officiel docs: https://squidfunk.github.io/mkdocs-material/reference/annotations/

Actual behaviour

Annotations does not close as shown in the gif.

Steps to reproduce

  1. Use a clean mkdocs project
  2. Use the material theme with insiders
  3. Enable the theme feature navigation.instant
  4. Enable the markdown extensions pymdownx.superfences, attr_list and md_in_html

Package versions

  • Python 3.10.2
  • MkDocs 1.2.3
  • Material 8.2.5+insiders.4.11.0

Configuration

site_name: Irezia - Wiki
repo_name: Irezia-Wiki on GitHub
copyright: "© 2022  Irezia"
docs_dir: docs
theme:
  name: material
  features:
    - navigation.instant
markdown_extensions:
  - pymdownx.superfences
  - attr_list
  - md_in_html

System information

  • Operating system: Windows 10
  • Browser: Opera GX LVL3 (core: 83.0.4254.70), Firefox 97.0.1

Activity

squidfunk

squidfunk commented on Mar 26, 2022

@squidfunk
Owner

Thanks for reporting! Fixed in 72975c7. There was indeed a side effect for annotations when instant loading was enabled. Sorry this took so long – I was on vacation in the meantime 😉

added
bugIssue reports a bug
resolvedIssue is resolved, yet unreleased if open
and removed
needs investigationIssue must be investigated by the maintainers
on Mar 26, 2022
squidfunk

squidfunk commented on Mar 27, 2022

@squidfunk
Owner

Released as part of 8.2.8+insiders-4.12.0.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugIssue reports a bugresolvedIssue is resolved, yet unreleased if open

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      No branches or pull requests

        Participants

        @squidfunk@superhize

        Issue actions

          Annotations does not work with the theme feature navigation.instant · Issue #3685 · squidfunk/mkdocs-material