MkDocs plugin providing media galleries with shortcodes
Project description
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 (optionallycategory="...")
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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file mkdocs_media_gallery_plugin-1.0.0.tar.gz.
File metadata
- Download URL: mkdocs_media_gallery_plugin-1.0.0.tar.gz
- Upload date:
- Size: 10.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8991967ea1c3ebc7a3bdebc76e1fe5ef3ce5f16fe06e41ec5081a3399b0e2124
|
|
| MD5 |
2ce1e0896a7d3ab74281d5938bab9035
|
|
| BLAKE2b-256 |
b69d275638375c61b20d2689916cbf206e1f59e4a8f0c9a761b9232608cd3248
|
File details
Details for the file mkdocs_media_gallery_plugin-1.0.0-py3-none-any.whl.
File metadata
- Download URL: mkdocs_media_gallery_plugin-1.0.0-py3-none-any.whl
- Upload date:
- Size: 12.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c639776eeb45b6010ab13487c2163a062e43668a5252c510a23c16d0c5b6c1a0
|
|
| MD5 |
37f6f75c6cd42ed6b0dd623cc8f57e5c
|
|
| BLAKE2b-256 |
4736ce3c3468aa72332003812c21a937c6ccb132fd4c941c381a856e79b258d0
|
