# 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](https://realtimeprojects.github.io/mkdocs-ezglossary)
## Prerequisites
This plugin requires the
[material definition lists](https://squidfunk.github.io/mkdocs-material/reference/lists/)
to be active or any other plugin which generates
[html description lists](https://www.w3schools.com/HTML/html_lists.asp).
## Installation
pip install mkdocs-ezglossary-plugin
## Quickstart
### Activation
Add the following lines to your mkdocs.yml plugins section:
``` yaml
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:
``` markdown
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:
``` markdown
- See the <section:term> for details
```
### Printing a summary
Now you can place a summary of all definitions anywhere in your
documentation:
``` markdown
# Terms and Definitions
<glossary::section>
```
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/8c/c1/e055a191ac45a44a341ed7011207facce63075da7ac831f5ea74306c24c6/mkdocs_ezglossary_plugin-1.6.8.tar.gz",
"platform": null,
"description": "# mkdocs ezglossary plugin\n> Glossary support for mkdocs.\n\n## Features\n\n- Defining multiple glossaries\n- Linking to glossary entries in text\n- Printing a summary of your glossary with definitions and\n references anywhere in your documentation.\n- Customizable output\n- Unicode support\n- PDF support\n\n## Documentation\n\n- Read the [full documentation](https://realtimeprojects.github.io/mkdocs-ezglossary)\n\n## Prerequisites\n\nThis plugin requires the\n[material definition lists](https://squidfunk.github.io/mkdocs-material/reference/lists/)\nto be active or any other plugin which generates\n[html description lists](https://www.w3schools.com/HTML/html_lists.asp).\n\n## Installation\n\n pip install mkdocs-ezglossary-plugin\n\n## Quickstart\n\n### Activation\n\nAdd the following lines to your mkdocs.yml plugins section:\n\n``` yaml\nplugins:\n - search\n - ezglossary\n```\n\n### Defining glossary entries\n\nProvided you use the material definition list, adding a glossary entry\njust works by adding a definition list with section specifiers anywhere\nin your documentation:\n\n``` markdown\nsection:term\n: A list of specialized words with their definitions\n```\n\n### Linking to a glossary entry\n\nYou can now link to this glossary definition using the following\nsyntax. This will produce a link to the definition in your documentation:\n\n``` markdown\n- See the <section:term> for details\n```\n\n### Printing a summary\n\nNow you can place a summary of all definitions anywhere in your\ndocumentation:\n\n``` markdown\n# Terms and Definitions\n\n<glossary::section>\n```\n",
"bugtrack_url": null,
"license": null,
"summary": "manage multiple glossaries in mkdocs",
"version": "1.6.8",
"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": "",
"digests": {
"blake2b_256": "e552d4cce456dc70959967581890f62593111bb256f5a5ca63718a638317cb8e",
"md5": "6e98a4dfd06bc9e5e06f1d2f4cdfbc48",
"sha256": "d44cababf000856c90f8b44eb2b1a905cb316552b17157cddc89b39ffc207d03"
},
"downloads": -1,
"filename": "mkdocs_ezglossary_plugin-1.6.8-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "6e98a4dfd06bc9e5e06f1d2f4cdfbc48",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 11404,
"upload_time": "2024-04-24T16:32:15",
"upload_time_iso_8601": "2024-04-24T16:32:15.001799Z",
"url": "https://files.pythonhosted.org/packages/e5/52/d4cce456dc70959967581890f62593111bb256f5a5ca63718a638317cb8e/mkdocs_ezglossary_plugin-1.6.8-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8cc1e055a191ac45a44a341ed7011207facce63075da7ac831f5ea74306c24c6",
"md5": "07edde9d9eac0300f3ec56664c9621ca",
"sha256": "89b2ee1c975e8baf8db19ae347ac16b2bd40cf9168882450e4a1d27f7c983347"
},
"downloads": -1,
"filename": "mkdocs_ezglossary_plugin-1.6.8.tar.gz",
"has_sig": false,
"md5_digest": "07edde9d9eac0300f3ec56664c9621ca",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 11179,
"upload_time": "2024-04-24T16:32:16",
"upload_time_iso_8601": "2024-04-24T16:32:16.153809Z",
"url": "https://files.pythonhosted.org/packages/8c/c1/e055a191ac45a44a341ed7011207facce63075da7ac831f5ea74306c24c6/mkdocs_ezglossary_plugin-1.6.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-24 16:32:16",
"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
