mkdocs plugin for glossaries
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.
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.1.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ac1818f6006486064c0d56b4db8c9b1e8650578b475b33b0d91fd5c9d7064d01 |
|
MD5 | 75e84702684facd364ad830fd1ea47f3 |
|
BLAKE2b-256 | c3a828219717a0638d7d595d43b5479cda2a82068070c2e07db1794e63b7878a |
Hashes for mkdocs_ezglossary_plugin-1.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2a6129284446e1043955e4a5c52c527d07fce51b27c582580cc4d0fc1ccf9e6a |
|
MD5 | 01a42b8dc9fe738683d4bea231a4acb0 |
|
BLAKE2b-256 | 05fb3cb010d9b90a0cf5f5100a31e79893fa6b373cca43a3707c0e39d61214c5 |