mkdocs-ezglossary-plugin
A powerful glossary plugin for MkDocs
Features
- Multiple glossary sections
- Case-sensitive and case-insensitive term matching
- Rich text formatting in definitions
- Reference tracking and linking
- Customizable summaries
- Unicode support
- PDF export support
- Custom templates via Jinja2
- Plural forms support (English, Spanish, French, German)
Documentation
📚 Read the full documentation
Prerequisites
This plugin requires one of:
- Material for MkDocs definition lists (recommended)
- Any plugin that generates HTML description lists
Installation
pip install mkdocs-ezglossary-plugin
Quick Start
1. Enable the Plugin
Add ezglossary to your mkdocs.yml:
plugins:
- search
- ezglossary
2. Define Terms
Add glossary terms anywhere in your documentation:
fruit:apple
: A very delicious and healthy fruit growing on trees.
3. Link to Terms
Reference terms in your documentation:
An <fruit:apple> a day keeps the doctor away.
4. Create a Summary
Generate a summary of all terms:
# Glossary
<glossary::fruit>
Configuration
Basic configuration options:
plugins:
- ezglossary:
# Case-insensitive term matching
ignore_case: true
# Show references in definitions
inline_refs: short # none, short, list
# Enable plural forms (English)
plurals: en # en, es, it, fr, de
# Custom templates directory
templates: docs/templates
See the configuration documentation for all options.
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
License
mkdocs-ezglossary-plugin is distributed under the terms of the MIT license.
1 maintainer
Metadata
1 maintainer
Release files for mkdocs-ezglossary-plugin 2.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| mkdocs_ezglossary_plugin-2.1.0.tar.gz | 20.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| mkdocs_ezglossary_plugin-2.1.0-py2.py3-none-any.whl | Python 3, Python 2 | none | any | Details |
Total release size: 36.4 kB
Release files / mkdocs_ezglossary_plugin-2.1.0.tar.gz
| Download URL | mkdocs_ezglossary_plugin-2.1.0.tar.gz |
|---|---|
| Size | 20.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1494041d005caea7a15189d095daf7e13e9ed3249adc3df9af50683e615002c3
|
|
BLAKE2b-256 checksum How to use checksums |
ebc5e7b2e54fc96fdaf415ded704103b3a73b0a57e19c164f2a27045024fcbed
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 25, 2025.
Transparency logRelease files / mkdocs_ezglossary_plugin-2.1.0-py2.py3-none-any.whl
| Download URL | mkdocs_ezglossary_plugin-2.1.0-py2.py3-none-any.whl |
|---|---|
| Size | 16.0 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
42a5527882a168b042ce6661dadc4e009b9b74a971d4f7e881e2a4df5fe2b3f6
|
|
BLAKE2b-256 checksum How to use checksums |
102dcca2b58941f7edb9266f3b2f8fabf0a587f980c475309d7cbbd3a8f43c9b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 25, 2025.
Transparency log
