manage multiple glossaries in mkdocs
Project description
mkdocs ezglossary plugin
Glossary support for mkdocs.
Features
- 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
- Unicode support
- PDF support
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
Close
Hashes for mkdocs_ezglossary_plugin-1.6.9.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1645d21985fe3bfe9285a0874cbcd52831aff75da622bb41ff6d7663e7b3f101 |
|
MD5 | 3b5959fde6278f7eee89ba65cb46447d |
|
BLAKE2b-256 | 758c4d74651621eb631d7b58ef9000f1199e65f740390977bb5ab0ebde8be3e7 |
Close
Hashes for mkdocs_ezglossary_plugin-1.6.9-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5e95a496202d6d41dee59757b0d2e3082305661ed98405bd34a4d0df91053459 |
|
MD5 | 76d4626e8b8428bccc8913d8ccfb471d |
|
BLAKE2b-256 | b5a31942c1a5f0474d90b7629832f497e33a94a5422d3ffe0408f792195c2287 |