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.5.8.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c4cce9dc57cf9a57576ea2308a7fa8cd8ebb84a2abf0a53b5c5119f77575e458 |
|
MD5 | 54e100203cf9228aeddcededb476173d |
|
BLAKE2b-256 | bfccdbf5869c64ef153ff685ce0099476e611c5b7223beb1c94fa6fc93ad2cb5 |
Hashes for mkdocs_ezglossary_plugin-1.5.8-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 00cd46ff9e5f7d83d60f91b6bb185f2baf62abf8eaa8dc2cb4b797930d873a3c |
|
MD5 | 553dea7d7e85505f724b776797331575 |
|
BLAKE2b-256 | 42cd43794d10a8a1f3a2461f82318d9ef313dfffb9a7f0a89367b7f29cec8f63 |