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.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f0ccc41bc95bebf65ec023ec82cfef6add4ad7382dec7537197c9f2ea5d23c50 |
|
MD5 | d666b2bbe04f303e4df562a259456104 |
|
BLAKE2b-256 | b09199baef641699647e746afc75c963e8d04d1aed5bd133ecce68bc80549316 |
Hashes for mkdocs_ezglossary_plugin-1.5.4-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7ccb7217661b9cafb55b001861e5e726ad87b7fbd7e3267ca91d781feebc6b04 |
|
MD5 | cebaafdc9d1e79302e900121fd1c32e2 |
|
BLAKE2b-256 | 9ac0ce08572aece1f8442d4f788ed6a433599aaa9bd745c39567026eade120c9 |