manage multiple glossaries in mkdocs
Project description
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>
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for mkdocs_ezglossary_plugin-1.6.10.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 1cfdd3679ae6188f5e9519e74b90aaa638ea533e687fa46b6c84dc2c0ad15b73 |
|
| MD5 | 3b32110d0f0846b681dc0cdb6f733000 |
|
| BLAKE2b-256 | dfb115bb0a0b20a1d353e172b5c43c21403f7b520a4c19632fdbf5c6d556e763 |
Close
Hashes for mkdocs_ezglossary_plugin-1.6.10-py2.py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | b40dfce4264b2f56e1b159f675ea96247bfddf0196f861789e1d5837f4f03bf6 |
|
| MD5 | a1975cfee2b61c6b9962b99564fe95b5 |
|
| BLAKE2b-256 | c0ac943e52532697f730951cc2af1b30f9a5d35ac34bd43016889f1e881df43a |
