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 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.5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a8371a0ea32e20b7daf78d1ea1234c8dd1e04bd30211199623e4a11994635407 |
|
MD5 | 7ff7bdf737a12f272e0fc9d21a5676bd |
|
BLAKE2b-256 | 8c14ea0377550d84e078396ba99849634d46a79d2c4fc5969a3b6246d4346f8c |
Hashes for mkdocs_ezglossary_plugin-1.5.5-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fa34b794056babb91bd0bcdc6613a67db0943d93a7dd71b013fbd2cf2ba03ce5 |
|
MD5 | b84260f877d5d474842f841cda2bd162 |
|
BLAKE2b-256 | c13d0145182dc63cf7e3f9a01d6711629c2916cb000afc40f744e4c80e7814de |