# mkdocs-ezglossary-plugin
> A powerful glossary plugin for MkDocs
## Features
- Multiple glossary sections
- Case-sensitive and case-insensitive term matching
- Rich text formatting in definitions
- Reference tracking and linking
- Customizable summaries
- Unicode support
- PDF export support
- Custom templates via Jinja2
- Plural forms support (English)
## Documentation
📚 Read the [full documentation](https://realtimeprojects.github.io/mkdocs-ezglossary)
## Prerequisites
This plugin requires one of:
- [Material for MkDocs definition lists](https://squidfunk.github.io/mkdocs-material/reference/lists/) (recommended)
- Any plugin that generates [HTML description lists](https://www.w3schools.com/HTML/html_lists.asp)
## Installation
```bash
pip install mkdocs-ezglossary-plugin
```
## Quick Start
### 1. Enable the Plugin
Add ezglossary to your mkdocs.yml:
```yaml
plugins:
- search
- ezglossary
```
### 2. Define Terms
Add glossary terms anywhere in your documentation:
```markdown
fruit:apple
: A very delicious and healthy fruit growing on trees.
```
### 3. Link to Terms
Reference terms in your documentation:
```markdown
An <fruit:apple> a day keeps the doctor away.
```
### 4. Create a Summary
Generate a summary of all terms:
```markdown
# Glossary
<glossary::fruit>
```
## Configuration
Basic configuration options:
```yaml
plugins:
- ezglossary:
# Case-insensitive term matching
ignore_case: true
# Show references in definitions
inline_refs: short # none, short, list
# Enable plural forms (English)
plurals: en # none, en
# Custom templates directory
templates: docs/templates
```
See the [configuration documentation](https://realtimeprojects.github.io/mkdocs-ezglossary/configuration) for all options.
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
## License
`mkdocs-ezglossary-plugin` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
Raw data
{
"_id": null,
"home_page": null,
"name": "mkdocs-ezglossary-plugin",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "mkdocs, glossary, plugin, references, links",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/63/7b/07b2c6064afba20d1d3b4a84428c0de156c5f140d5454ea02324e046a2b4/mkdocs_ezglossary_plugin-2.0.0.tar.gz",
"platform": null,
"description": "# mkdocs-ezglossary-plugin\n\n> A powerful glossary plugin for MkDocs\n\n## Features\n\n- Multiple glossary sections\n- Case-sensitive and case-insensitive term matching\n- Rich text formatting in definitions\n- Reference tracking and linking\n- Customizable summaries\n- Unicode support\n- PDF export support\n- Custom templates via Jinja2\n- Plural forms support (English)\n\n## Documentation\n\n\ud83d\udcda Read the [full documentation](https://realtimeprojects.github.io/mkdocs-ezglossary)\n\n## Prerequisites\n\nThis plugin requires one of:\n- [Material for MkDocs definition lists](https://squidfunk.github.io/mkdocs-material/reference/lists/) (recommended)\n- Any plugin that generates [HTML description lists](https://www.w3schools.com/HTML/html_lists.asp)\n\n## Installation\n\n```bash\npip install mkdocs-ezglossary-plugin\n```\n\n## Quick Start\n\n### 1. Enable the Plugin\n\nAdd ezglossary to your mkdocs.yml:\n\n```yaml\nplugins:\n - search\n - ezglossary\n```\n\n### 2. Define Terms\n\nAdd glossary terms anywhere in your documentation:\n\n```markdown\nfruit:apple\n: A very delicious and healthy fruit growing on trees.\n```\n\n### 3. Link to Terms\n\nReference terms in your documentation:\n\n```markdown\nAn <fruit:apple> a day keeps the doctor away.\n```\n\n### 4. Create a Summary\n\nGenerate a summary of all terms:\n\n```markdown\n# Glossary\n\n<glossary::fruit>\n```\n\n## Configuration\n\nBasic configuration options:\n\n```yaml\nplugins:\n - ezglossary:\n # Case-insensitive term matching\n ignore_case: true\n \n # Show references in definitions\n inline_refs: short # none, short, list\n \n # Enable plural forms (English)\n plurals: en # none, en\n \n # Custom templates directory\n templates: docs/templates\n```\n\nSee the [configuration documentation](https://realtimeprojects.github.io/mkdocs-ezglossary/configuration) for all options.\n\n## Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request.\n\n## License\n\n`mkdocs-ezglossary-plugin` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.\n",
"bugtrack_url": null,
"license": null,
"summary": "manage multiple glossaries in mkdocs",
"version": "2.0.0",
"project_urls": {
"Bug Tracker": "https://github.com/realtimeprojects/mkdocs-ezglossary/issues",
"Documentation": "https://realtimeprojects.github.io/mkdocs-ezglossary",
"Homepage": "https://github.com/realtimeprojects/mkdocs-ezglossary"
},
"split_keywords": [
"mkdocs",
" glossary",
" plugin",
" references",
" links"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "490769db1299e822eb8d564460be254593f293ed9e88f5977721eb3893170361",
"md5": "dcca9a48db5ef13ea3cc914f518c76b0",
"sha256": "9539b249f7ac7051525dab2d56ba27b3c2e776e7c6afba898b1eaed2eae9beb7"
},
"downloads": -1,
"filename": "mkdocs_ezglossary_plugin-2.0.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "dcca9a48db5ef13ea3cc914f518c76b0",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 14444,
"upload_time": "2025-02-10T20:58:06",
"upload_time_iso_8601": "2025-02-10T20:58:06.488823Z",
"url": "https://files.pythonhosted.org/packages/49/07/69db1299e822eb8d564460be254593f293ed9e88f5977721eb3893170361/mkdocs_ezglossary_plugin-2.0.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "637b07b2c6064afba20d1d3b4a84428c0de156c5f140d5454ea02324e046a2b4",
"md5": "1538cffc6e9512765f3928ea45490730",
"sha256": "bfd3f16ca5142436889d553bdd674201fc77aa4b94cba7819fb8f106720d9194"
},
"downloads": -1,
"filename": "mkdocs_ezglossary_plugin-2.0.0.tar.gz",
"has_sig": false,
"md5_digest": "1538cffc6e9512765f3928ea45490730",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 17818,
"upload_time": "2025-02-10T20:58:08",
"upload_time_iso_8601": "2025-02-10T20:58:08.710611Z",
"url": "https://files.pythonhosted.org/packages/63/7b/07b2c6064afba20d1d3b4a84428c0de156c5f140d5454ea02324e046a2b4/mkdocs_ezglossary_plugin-2.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-10 20:58:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "realtimeprojects",
"github_project": "mkdocs-ezglossary",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "mkdocs-ezglossary-plugin"
}
JSON
