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:
term:glossary
: 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 <term:glossary> 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.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3aa7306f7c9537bd1090e12b5a9057228a73912976e5f7b9c93ec09394da6308 |
|
MD5 | 0a30fdc5683b5e5391c42222ebfbc212 |
|
BLAKE2b-256 | 5dd51f9c3c3d9a8ce8db71be1dca99fdcc10d89e8280e7d965256aac6ade9b83 |
Hashes for mkdocs_ezglossary_plugin-1.5.2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6175459998da916672a5f5762f4d5d85aedfcf461ff770c2b0927636291a88a7 |
|
MD5 | 8ad29b9d729862f40abbf3350bbc3f5c |
|
BLAKE2b-256 | d375d57cbf4558d1b10d7a6374c0e4b652b22f89ac5de8809df5c17614135724 |