manage multiple glossaries in mkdocs
Project description
mkdocs ezglossary plugin
Glossary support for mkdocs.
Features
- 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
- Unicode support
- PDF support
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
Close
Hashes for mkdocs_ezglossary_plugin-1.6.6.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8630230747101de0f12434769dc6531c8a6e4bec93ff7bc99329f9a43773e3c0 |
|
MD5 | 8161ccdf2b66fef54f3211077510cc5e |
|
BLAKE2b-256 | 1909de84e4cafcc713b564b778e97899aae9d4acd3a941eab48b44588f2433fd |
Close
Hashes for mkdocs_ezglossary_plugin-1.6.6-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2b1db1f4ddf4d1e818045e743af54b2a931bc451f3b8224ab09e40482b5a56f1 |
|
MD5 | 148b02d35a568b8c0bad0c1df6a1a353 |
|
BLAKE2b-256 | f2283fbba434f2a8599a360977ccf356729148e4ed16ea3705a5ac4ea3aa5429 |