manage multiple glossaries in mkdocs
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:
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 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.7.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4f4bf273c036c6ae884f51e84086e671c1f138130de0a0d6e5ab661ce972bd02 |
|
MD5 | e6cefb5856bfa4460560e80fda937b67 |
|
BLAKE2b-256 | d21c68752be1686e2d4765e825aff502987191064f841a79e0867c34281f5c18 |
Hashes for mkdocs_ezglossary_plugin-1.5.7-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d36a1dc6ee1354b1bf61e84f1871912cb8aa3acf6a79465f169c3b40ee9ba934 |
|
MD5 | d90fd8a9b6e52116fa8056a857fd4909 |
|
BLAKE2b-256 | f5e90dfff8d140a7dd1e2bbde7541d9809dc1e7e9f3f51dfbe81909e58ffb8e9 |