mkdocs plugin for glossaries
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.
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
Usage
Activation
Add the following lines to your mkdocs.yml plugins section:
plugins:
- search
- glossary
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
: My definition
!!! Example:
``` markdown
terms: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 <section:term> for details
!!! Example:
``` markdown
- See the <terms:glossary> for details
```
Printing a summery
Now you can place a summary of all definitions anywhere in your documentation:
# Terms and Definitions
<glossary::term>
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.0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b0ad1f96ab89d1e20eac43410887239278b4b53c045139f9e3d4bfbf2f9a1993 |
|
MD5 | b2fb86f2dc8f0c4feeca804206e1ee9f |
|
BLAKE2b-256 | 8c26c108e81b339739b4957eff0f71b877c05692f674c0922d3653b684056a67 |
Hashes for mkdocs_ezglossary_plugin-1.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 53846c6a19a499bfb7367b399b3292b42b6a88b42f82c0f8a305a34409ecab08 |
|
MD5 | f9c73260613a0997dfdd32573583e0b9 |
|
BLAKE2b-256 | bc8e829c199a63d8cb6acc4832ef83de6af4e41f4e1166581316625c128e06b7 |