manage multiple glossaries in mkdocs
Project description
mkdocs ezglossary plugin
Glossary support for mkdocs.
Features
- 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
- Unicode support
- PDF support
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 summary
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
Close
Hashes for mkdocs_ezglossary_plugin-1.7.0a2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ddedf2136a799415a63d3c46f8da69f4dba3d9a5a5855afdf87ef77383ff9069 |
|
MD5 | 1ef91670ede37717e5f811ad68ab634f |
|
BLAKE2b-256 | cb7e10eb325e0d071e10899493c584c51df9ad2eff22dfda264a13c415fe3fae |
Close
Hashes for mkdocs_ezglossary_plugin-1.7.0a2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b07ec083e8f13e18fe737172fe26abea253b35bf2bcc953f91fa0a0cc64b8c22 |
|
MD5 | 803b16ec42fdb17e2e62e110502335b7 |
|
BLAKE2b-256 | 6816373781732d6431ac7f6ab1e21fccf48aab57231b2073a6ae63f8cedc75e3 |