Mkdocs Glightbox
A MkDocs plugin supports image lightbox (zoom effect) with GLightbox.
Overview:
MkDocs GLightbox is a plugin that adds image lightbox functionality to MkDocs, utilizing the GLightbox pure javascript library with mobile support. It allows for easy integration of a lightbox effect for images in your MkDocs documentation.
Features:
- Easy Integration: Quickly add image lightbox functionality to your MkDocs documentation.
- Customizable Options: Modify touch navigation, effects, captions, background, and more through the mkdocs.yml configuration file.
- Flexibility: Enable or disable the lightbox effect globally, by image, or by page for tailored implementation.
- Support for Image Captions: Add captions to lightbox images for additional context.
- Grouping Images: Create image galleries by grouping related images together.
Summary:
MkDocs GLightbox is a versatile plugin that enhances MkDocs documentation by providing image lightbox functionality through the GLightbox javascript library. With customizable options, support for image captions, and the ability to group images into galleries, this plugin offers a convenient way to improve the visual presentation of images in your documentation. The flexibility to enable or disable the lightbox effect at different levels ensures that you can tailor the user experience to fit your specific needs.
- MkDocs
MkDocs is a fast, simple and downright gorgeous static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file.
