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.7a1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | dd794b065d4ea73cb3e512a43800a0c8df39c3d7ac1d07f0af3d3720e53b4e6a |
|
MD5 | e13a75b4822aec78f7fc9d7827a0ad01 |
|
BLAKE2b-256 | 2a93e9061d919109448bd743f2f8cdc59f909720b2cf412db1cd61909cce01aa |
Hashes for mkdocs_ezglossary_plugin-1.5.7a1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e7a930448ff2fe0d79f88568149cd4b55000df334c400ece9cd2efb272e37061 |
|
MD5 | 98f350bbeaf47e1303a454220ddb27c7 |
|
BLAKE2b-256 | 5e726713d586e58e366fced1983e57a8e4c9de6c222373397cc4549b6bff7e09 |