No project description provided
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:
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.3.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 87917abb29b6ef9eac5928c07ac563a0af7bf59f7ff7a430bcefadd2e2d8f2fc |
|
MD5 | 78539d5f5cd3fd5b69dd98748b9f6e72 |
|
BLAKE2b-256 | 36a0d381cf9a8dfc419ce8e7696d16ee3b23075f2adfd2c61567e94b1450bf57 |
Hashes for mkdocs_ezglossary_plugin-1.3.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e173d0eb91bc8349376948a078b71f6e6d505c0573a67ba66e3fe15edad33bdc |
|
MD5 | d3e0e3990511314abd5b90002bbc5a70 |
|
BLAKE2b-256 | 6c5bf8c8589e25ae4b053941a32116fe1eb93b42a85cac735d4ca1f51154c06a |