mkdocs-ezglossary-plugin

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)

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  # none, en
      
      # 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.