Skip to main content

MKDOCS Media Galleries

MkDocs plugin for that adds image and YouTube galleries with shortcodes.

Install

pip install mkdocs-media-gallery-plugin

Configure (mkdocs.yml)

plugins:
  - search
  - media-gallery:
      images_path: images            # relative to docs_dir
      youtube_links_path: youtube-links.yaml  # relative to docs_dir
      generate_category_pages: true  # auto-generate one page per category

Shortcodes in Markdown

  • {{ gallery_preview }}: Shows preview tiles for each category (folder under images_path)
  • {{ gallery_full category="cats" }}: Shows full gallery for the given category
  • {{ youtube_gallery }}: Renders YouTube gallery from YAML (optionally category="...")

YouTube data (docs/youtube-links.yaml)

# Either flat list
- https://www.youtube.com/watch?v=ZucM9aw6Qlo
- sHfe3nT5-jk

# Or categorized
Music:
- https://www.youtube.com/watch?v=mEK0owuRoks
Shows:
- https://www.youtube.com/watch?v=ZucM9aw6Qlo

Metadata

Release files for mkdocs-media-gallery-plugin 1.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mkdocs-media-gallery-plugin 1.0.0
File Size Uploaded Provenance Actions
mkdocs_media_gallery_plugin-1.0.0.tar.gz 10.3 kB Without provenance Details for mkdocs_media_gallery_plugin-1.0.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for mkdocs-media-gallery-plugin 1.0.0
File Interpreter ABI Platform Actions
mkdocs_media_gallery_plugin-1.0.0-py3-none-any.whl Python 3 none any Details for mkdocs_media_gallery_plugin-1.0.0-py3-none-any.whl

Total release size: 22.4 kB

Security for mkdocs-media-gallery-plugin 1.0.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page