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.2.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4480014db7e38f35209e6ac360ee861bbe76fbcc6a9d6ccf266a84b3df3336e0 |
|
MD5 | 2c433d625690e8e728ba6c4d16a29ae6 |
|
BLAKE2b-256 | 7c741bb8c4bb54f797bf3ea9c88feb12f2c970fda17c0239be0dd20d1f0bb496 |
Hashes for mkdocs_ezglossary_plugin-1.2.2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c179eea8f8317a6e18d31650cbfa7ab0618a240a2f0f6d67ee82e8bdaa802be1 |
|
MD5 | d89eabb4fc21a45e63b6ef353081ce45 |
|
BLAKE2b-256 | 50547349119a54d4ba69b75ef9f865646dc01f3263b54c80a8c7cf26cf4e9ed9 |