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>
Project details
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.8.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 89b2ee1c975e8baf8db19ae347ac16b2bd40cf9168882450e4a1d27f7c983347 |
|
MD5 | 07edde9d9eac0300f3ec56664c9621ca |
|
BLAKE2b-256 | 8cc1e055a191ac45a44a341ed7011207facce63075da7ac831f5ea74306c24c6 |
Close
Hashes for mkdocs_ezglossary_plugin-1.6.8-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d44cababf000856c90f8b44eb2b1a905cb316552b17157cddc89b39ffc207d03 |
|
MD5 | 6e98a4dfd06bc9e5e06f1d2f4cdfbc48 |
|
BLAKE2b-256 | e552d4cce456dc70959967581890f62593111bb256f5a5ca63718a638317cb8e |