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.6.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 330d2390229cba39e408398aec630d24911d87798d33157ed07220073ea06058 |
|
MD5 | fdeccc4a3a7dd243b8cb62d68c183c09 |
|
BLAKE2b-256 | 1697dfb806ec0e240cc6887988abf6213b7e896c26d419176730fa0b6768a363 |
Hashes for mkdocs_ezglossary_plugin-1.5.6-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e37d28c19f629635f07e45c71c676fe876c8065bd399f9459da02d3a5e79112c |
|
MD5 | e912da938be8142077009288112a2a47 |
|
BLAKE2b-256 | 4b3f7373f55d75e33cd5f823e12ee65f841870fea85ac1ba03bcbda0387c9e9c |