mkdocs ezglossary plugin

Glossary support for mkdocs.

Features

• Defining multiple glossaries
• Linking to glossary entries in text
• Printing a summary of your glossary with definitions and references anywhere in your documentation.
• Customizable output
• Unicode support
• PDF support

Documentation

• Read the full documentation

Prerequisites

This plugin requires the material definition lists to be active or any other plugin which generates html description lists.

Installation

pip install mkdocs-ezglossary-plugin

Quickstart

Activation

Add the following lines to your mkdocs.yml plugins section:

plugins:
  - search
  - ezglossary

Defining glossary entries

Provided you use the material definition list, adding a glossary entry just works by adding a definition list with section specifiers anywhere in your documentation:

section:term
:   A list of specialized words with their definitions

Linking to a glossary entry

You can now link to this glossary definition using the following syntax. This will produce a link to the definition in your documentation:

-   See the <section:term> for details

Printing a summary

Now you can place a summary of all definitions anywhere in your documentation:

# Terms and Definitions

<glossary::section>