mkdocs plugin for glossaries
Project description
mkdocs ezglossary plugin
Features
This plugin adds glossary support for mkdocs. It supports
- Defining multiple glossaries
- Linking to glossary entries in text
- Printing a summary of your glossary with definitions and references anywhere in your documentation.
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:
term:glossary
: 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 <term:glossary> for details
Printing a summery
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
Hashes for mkdocs-ezglossary-plugin-1.1.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 136efdbcd0bdba12c8e4f495de742b659e6f5806363217555e99bb9c725a1e7b |
|
MD5 | 061a8d050fdfff53800f62943bc66ecd |
|
BLAKE2b-256 | 9a4df396de7ca088ca0d8ff3e994abb2cf3935e8c3156677abea797214a803a6 |
Hashes for mkdocs_ezglossary_plugin-1.1.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 00e98396387d379406e08420ecbb9ec8ca7e765269f65ad24b8c1dffcc73f510 |
|
MD5 | 4e5ac0baec528eea76115b2c5d5b93b2 |
|
BLAKE2b-256 | d24539ba0c98a037b1e0f9bbbd9e4bb2a932b05b8e53bae78d394b30c95dc4e8 |