# mkdocs-image-gallery-plugin
MKDocs plugin to autogenerate a gallery based on a folder of images
## How to use this plugin?
Add this plugin to your mkdocs.yml configuration as follows:
``` yml
plugins:
- image-gallery:
image_folder: "./assets/images/gallery" # Folder in the docs directory containing images
```
## Short Code Usage
Add these short codes to any markdown page in your docs to use the image gallery plugin.
Display Preview Gallery
`{{gallery_preview}}`
Display Full Gallery
`{{gallery_html}}`
Simple.
## Add to Main Nav
Dont forget to add the page that contains your `{{gallery_html}}` short code to the main nav config in `mkdocs.yml` to have a link in the main navigation
Example:
```
nav:
- Gallery: gallery.md
```
## The Future
More customization options coming.
## Notes
This plugin requires `glightbox` plugin to display clicked images in a lightbox.
`pip install mkdocs-glightbox`
## Server URLs
Offline plugin causes .html in the gallery urls. This plugin supports both server urls and offline urls.
Raw data
{
"_id": null,
"home_page": "https://github.com/APinchofDill/mkdocs-image-gallery-plugin",
"name": "mkdocs-image-gallery-plugin",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "mkdocs image gallery",
"author": "APinchofDill",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/9c/37/935649251b8d4c5f7cbf43dfe7ef1fe2f350382e8a6d81c7c69b139735f1/mkdocs_image_gallery_plugin-1.1.2.tar.gz",
"platform": null,
"description": "# mkdocs-image-gallery-plugin\r\nMKDocs plugin to autogenerate a gallery based on a folder of images\r\n\r\n## How to use this plugin?\r\n\r\nAdd this plugin to your mkdocs.yml configuration as follows:\r\n\r\n``` yml\r\nplugins:\r\n - image-gallery:\r\n image_folder: \"./assets/images/gallery\" # Folder in the docs directory containing images\r\n```\r\n\r\n## Short Code Usage\r\n\r\nAdd these short codes to any markdown page in your docs to use the image gallery plugin.\r\n\r\nDisplay Preview Gallery\r\n`{{gallery_preview}}`\r\n\r\nDisplay Full Gallery\r\n`{{gallery_html}}`\r\n\r\nSimple.\r\n\r\n## Add to Main Nav\r\n\r\nDont forget to add the page that contains your `{{gallery_html}}` short code to the main nav config in `mkdocs.yml` to have a link in the main navigation\r\n\r\nExample:\r\n\r\n```\r\nnav:\r\n - Gallery: gallery.md\r\n```\r\n\r\n## The Future\r\n\r\nMore customization options coming.\r\n\r\n\r\n## Notes\r\n\r\nThis plugin requires `glightbox` plugin to display clicked images in a lightbox.\r\n\r\n`pip install mkdocs-glightbox`\r\n\r\n## Server URLs\r\n\r\nOffline plugin causes .html in the gallery urls. This plugin supports both server urls and offline urls.\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "An MkDocs plugin to generate an image gallery from a folder of images",
"version": "1.1.2",
"project_urls": {
"Homepage": "https://github.com/APinchofDill/mkdocs-image-gallery-plugin"
},
"split_keywords": [
"mkdocs",
"image",
"gallery"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bfe8688834de8873de05fbb6541dbce2a6bac10e29c4337d64eb6d18acd51f57",
"md5": "cc2d1b645454855b8cda4799c8adaaf7",
"sha256": "ba13b748886e2d9037d84410d9117bb14844d319d881e9771dc0dfd895babf05"
},
"downloads": -1,
"filename": "mkdocs_image_gallery_plugin-1.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cc2d1b645454855b8cda4799c8adaaf7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 8001,
"upload_time": "2025-01-05T21:58:59",
"upload_time_iso_8601": "2025-01-05T21:58:59.478793Z",
"url": "https://files.pythonhosted.org/packages/bf/e8/688834de8873de05fbb6541dbce2a6bac10e29c4337d64eb6d18acd51f57/mkdocs_image_gallery_plugin-1.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9c37935649251b8d4c5f7cbf43dfe7ef1fe2f350382e8a6d81c7c69b139735f1",
"md5": "4647cf6269018259c621a5a1771980a5",
"sha256": "7755c3f421a178db7d6de7f5c562543fe107cacf4e5df4c680d1bcd492e7e652"
},
"downloads": -1,
"filename": "mkdocs_image_gallery_plugin-1.1.2.tar.gz",
"has_sig": false,
"md5_digest": "4647cf6269018259c621a5a1771980a5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 6263,
"upload_time": "2025-01-05T21:59:01",
"upload_time_iso_8601": "2025-01-05T21:59:01.778843Z",
"url": "https://files.pythonhosted.org/packages/9c/37/935649251b8d4c5f7cbf43dfe7ef1fe2f350382e8a6d81c7c69b139735f1/mkdocs_image_gallery_plugin-1.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-05 21:59:01",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "APinchofDill",
"github_project": "mkdocs-image-gallery-plugin",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "mkdocs-image-gallery-plugin"
}
JSON
