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:
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.5.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a390a04f4280e274a535bff23e469b1303250c99ba620d2319991629a38c37b1 |
|
MD5 | f6c4cc89e5322e25ebb9553ce5c4c19f |
|
BLAKE2b-256 | ab3a488bb8edaf87f747ec71a206970c536312b76a33038e94eb4d59ca402eea |
Hashes for mkdocs_ezglossary_plugin-1.5.3-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a3d06d12f4e653b2a612c2829682218f0da623fbc191a802b51803fa111daa60 |
|
MD5 | d0856e3a877bc98071413fb0b3e3e403 |
|
BLAKE2b-256 | e82ca07eabf9e79415c33a7eeaab52cc19efecc62ce0fe05dd9460c7b21a373c |