Skip to content

Abbreviations are not updated after adding a new one #148

@humberto-garciacaballero

Description

Context

No response

Bug description

When using the abbreviations and the glossary plugins things work as expected if you add the terms in the glossary and then you modify an .md file to include those abbreviations. However, if you add the terms without modifying the file, the result is that the file will not render the abbreviations correctly.

It seems to be related to the .cache folder. If this is removed, then the glossary is correctly displayed again.

Related links

Reproduction

reproduction.zip

Steps to reproduce

  1. Start from a fresh project.
  2. Modify the index.md file to have this content:
The HTML specification is maintained by the W3C.
  1. Save the file.
  2. Add necessary plugins as described in tooltips and glossary in your zensical.toml file:
[project.markdown_extensions.abbr]
[project.markdown_extensions.attr_list]
[project.markdown_extensions.pymdownx.snippets]
auto_append = ["includes/abbreviations.md"]
  1. Create an empty includes/abbreviations.md file (place it outside docs, i.e., root of your project).
  2. Execute zensical serve. This will create a .cache folder in the root of your project.
  3. Add the following content to the abbreviations.md file:
*[HTML]: Hyper Text Markup Language
*[W3C]: World Wide Web Consortium
  1. Visit the page.

At this point, the page should not display the abbreviations.

  1. Modify the content of the index.md file (e.g., add an space).
  2. Save the file.
  3. Visit the page.

At this point the page should be displaying the abbreviations correctly.

Browser

Chrome

Before submitting

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugIssue reports a bugresolvedIssue is resolved, yet unreleased if open

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions