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.7.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e669c854bb135d713389b769f33964618db9be367ac34677fcbdb44d1d61e4df |
|
MD5 | 1f4d0b08d8abb79e76c44987d8fc2970 |
|
BLAKE2b-256 | b4d00d579794012d1348cac7a69dfb6dfdda709ead967bb6763fe80485dbc5dc |
Close
Hashes for mkdocs_ezglossary_plugin-1.6.7-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ce36d58b9c9c990e900b6755f5433ce07fe505ea2c6eb2cc168fbdd830f791eb |
|
MD5 | db456d7175a4a2759b480a76356db464 |
|
BLAKE2b-256 | 33fbd732a40c9ef031a78a68d125efb9d1e55eb07d2191bf908c3b675b171958 |