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.5.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f5bd7833c784be353c4b43c5c3842e6af248d780114fe473a980d4e47a8d5b7c |
|
MD5 | 6cdb8d23d163cdb5da4b1db6b82257d4 |
|
BLAKE2b-256 | 94080a945f0c2de56c52ece5fc2e05489821059ee17362e95347306b2eb5859a |
Hashes for mkdocs_ezglossary_plugin-1.5.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3b8583ae4c0ff8d447d77758f3649f1b83f1662f5ee6369a41bb9f341aab04c2 |
|
MD5 | 96183847509d9a95d4346a16bd4dbb70 |
|
BLAKE2b-256 | f7974d76bb86d6bbdd58d769e7b6199deb24786113136213ac2a9e6b67ccbca0 |