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.6.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c62255232d44f55d25538cc5b373b87b4e819177c4d7e6e6e4df59844aee5f90 |
|
MD5 | 24777c6e5ab52d3ace3e3378954c4177 |
|
BLAKE2b-256 | 72b10b3e42f4a9f83532d87018b8decbecc96b965e868a5a335fe9eb941839d5 |
Hashes for mkdocs_ezglossary_plugin-1.6.4-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bd7151e3349518e4bc807b191334c18b5400603fbadfbce051874e979560cdfa |
|
MD5 | 6e3c4073c5181394abd84946afe14378 |
|
BLAKE2b-256 | dd17ca2ba14be0e457dfed52984cff4ecfe6c0e32bbe87249ca9b68a747de29c |