manage multiple glossaries in mkdocs
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.
- Customizable output
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
Hashes for mkdocs_ezglossary_plugin-1.6.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | be45b48dc7d930d1e111457ca7ac5f0d8d0b666ac605c4e945723b5e161c30fc |
|
MD5 | b1b6f70f321876082bccf5aa717097bd |
|
BLAKE2b-256 | 6e86cd1ab1ac090ea9c796ba716b0ddd010139cf82727f89647df786f20ada81 |
Hashes for mkdocs_ezglossary_plugin-1.6.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b100397c85b2fa8fb0125a3af731c22f2f356f63ff39a414821c6a7d60e6eaad |
|
MD5 | 4ba9730223997dd4b14093d459b4bd0d |
|
BLAKE2b-256 | f3b51df92f89ce98d41dedb3db0af5788081c3ca422396c308c185492116052b |