# 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/51/6e/e6c81bf8adada1afa9d73f969741c7340fc30f96851debbd8352c63967dd/mkdocs_image_gallery_plugin-1.1.1.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.1",
"project_urls": {
"Homepage": "https://github.com/APinchofDill/mkdocs-image-gallery-plugin"
},
"split_keywords": [
"mkdocs",
"image",
"gallery"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "02ce4319b6778e9a5ce38f640aa32f36da30d6651e675d577a10905974b72b8e",
"md5": "9c727aba526e83c54678bcb3da913102",
"sha256": "0cdf717d805b3d42c0838e83cd9737ea703d77f02f81f2f56e4263a7fe87f29f"
},
"downloads": -1,
"filename": "mkdocs_image_gallery_plugin-1.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9c727aba526e83c54678bcb3da913102",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 7999,
"upload_time": "2024-12-08T21:10:21",
"upload_time_iso_8601": "2024-12-08T21:10:21.739113Z",
"url": "https://files.pythonhosted.org/packages/02/ce/4319b6778e9a5ce38f640aa32f36da30d6651e675d577a10905974b72b8e/mkdocs_image_gallery_plugin-1.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "516ee6c81bf8adada1afa9d73f969741c7340fc30f96851debbd8352c63967dd",
"md5": "5be93346501dd733ef9c69c7e3692cc5",
"sha256": "3eb3af48aef5e7f93a0672db9b64165a0ba31b063a3eddac2d7260f7ea3f7a82"
},
"downloads": -1,
"filename": "mkdocs_image_gallery_plugin-1.1.1.tar.gz",
"has_sig": false,
"md5_digest": "5be93346501dd733ef9c69c7e3692cc5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 6303,
"upload_time": "2024-12-08T21:10:23",
"upload_time_iso_8601": "2024-12-08T21:10:23.183851Z",
"url": "https://files.pythonhosted.org/packages/51/6e/e6c81bf8adada1afa9d73f969741c7340fc30f96851debbd8352c63967dd/mkdocs_image_gallery_plugin-1.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-08 21:10:23",
"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
