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.3.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8cc5e6b78ed7d62d5a270a7410211a467d492423da2f0be5c1eb1e9ffc0bcc9b |
|
MD5 | 8e86a75ab2ceefd6aceb04c9af186854 |
|
BLAKE2b-256 | 1258c82fad0505feb4d26931ed56a1c3b34dc0900ce9bb596163862d790222ca |
Hashes for mkdocs_ezglossary_plugin-1.3.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3e25b71de5d69adb486277c08628ab2cc29dcd8b98d5a44c7aa51ca389ff7dd8 |
|
MD5 | c91858dded44b73686d72afad9f00a4c |
|
BLAKE2b-256 | 19f0144966390059d3d3063f2e5fc248359cd7e181f55d82e0df78c49db715b3 |