No project description provided
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.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7031cb7275f781d87598d2478c4ad46cfdf17166b5a01772f8feeb0445a2dbcb |
|
MD5 | 82d745aff41d438ce130551c419661c6 |
|
BLAKE2b-256 | eae4e6a7b34d84fcc70f65ebbfcab2ce264ef5caafab7b38ec4812c4504ba07a |
Hashes for mkdocs_ezglossary_plugin-1.5.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 136af4dd2cb52425c339f3271cd38dd9b46dd0fff2746ada46401817b1c3875e |
|
MD5 | 1cb9cab002c5e34a9842034dd16ed259 |
|
BLAKE2b-256 | 6a3a79e95abbbaf7f0545c6158ee360c5c2340aacb3d0d2996a7173572009580 |