mkdocs-image-gallery-plugin
Advanced tools
An MkDocs plugin to generate an image gallery from a folder of images
MKDocs plugin to autogenerate a gallery based on a folder of images
Add this plugin to your mkdocs.yml configuration as follows:
plugins:
- image-gallery:
image_folder: "./assets/images/gallery" # Folder in the docs directory containing images
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.
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
More customization options coming.
This plugin requires glightbox plugin to display clicked images in a lightbox.
pip install mkdocs-glightbox
Offline plugin causes .html in the gallery urls. This plugin supports both server urls and offline urls.
FAQs
An MkDocs plugin to generate an image gallery from a folder of images
We found that mkdocs-image-gallery-plugin demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.