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.7.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f0f899a3df76662effba6ff2b80b1c50eb6b15a6294efb7d43b4d607e5f14e4c |
|
MD5 | d99d2ff8887aa46118d672596de12f50 |
|
BLAKE2b-256 | 719cbcc8c6a7d7f5d5b0e77409ff491b1d9677f4f6cffe39f19bc0efc8a2cd4c |
Close
Hashes for mkdocs_ezglossary_plugin-1.7.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d2da91051dfe055220ac32793fc554309e836e8a7a94fa46f17fc955a455fee1 |
|
MD5 | 49b67cd329318154fe5cef49a73f037b |
|
BLAKE2b-256 | 28187feaaa666981836535cf23c6744945c1630007cedf753533480d90eccb68 |