No project description provided
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.4.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a57229fc405dfb959ecfdea82830241e5e494c5e5c340ce17ab60da0e8f5b444 |
|
MD5 | 4f06174160b640af95f5a0796d584119 |
|
BLAKE2b-256 | c87d56654eb848a1a2c533b6e8cc7f3afec31cd74e0fefabdebecc3191710267 |
Hashes for mkdocs_ezglossary_plugin-1.4.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7c95d8bf44bab92f669532841e572cd2728901b50066760469d82dd5896093ca |
|
MD5 | 8ae605985852eca3bbc840a5eee1d76d |
|
BLAKE2b-256 | dbebd1a750d9707fce32ef126e58426deb344284eae8d4c4eecf9146a1f64f5a |