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.7.0a3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 625130c0707fe8a14c2848649aa7d7c4ae1528bc3e27684c651b27d33646dda7 |
|
MD5 | 96edbe08bb2ae9dc3512ffa1ed1e2bf0 |
|
BLAKE2b-256 | 0adea5c77fd52af8f961577c8c277f80d2ce36ad705d0b0a9a2f9ae57e955cbd |
Close
Hashes for mkdocs_ezglossary_plugin-1.7.0a3-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | afb0c2dd5e3c6ba7f90278f54981addc1c5c87d8f435006b3b79135ff59bb1f7 |
|
MD5 | f96b45059c58ceb14e857b45205dd1d4 |
|
BLAKE2b-256 | 77dae6c0ebb77b642b2b049cbc3f9d7b6170c727205d772ecc28ce3d93083e93 |