Metadata-Version: 2.4
Name: mkdocs-media-gallery-plugin
Version: 1.0.0.dev35
Summary: MkDocs plugin providing media galleries with shortcodes
Author: APinchofDill
License-Expression: MIT
Project-URL: Homepage, https://github.com/APinchofDill/mkdocs-media-gallery-plugin
Keywords: mkdocs,image,gallery
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: mkdocs>=1.5
Requires-Dist: jinja2>=3.0
Requires-Dist: pyyaml>=6.0
Requires-Dist: mkdocs-glightbox>=0.4.0
Dynamic: license-file

# MKDOCS Media Galleries 

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

## Install

```bash
pip install mkdocs-media-gallery-plugin
```

## Configure (mkdocs.yml)

```yaml
site_name: Demo
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
theme:
  name: material
```

## 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)

```yaml
# Either flat list
- https://www.youtube.com/shorts/HgLzykU5wc8
- HgLzykU5wc8

# Or categorized
# music:
#   - https://www.youtube.com/shorts/HgLzykU5wc8
# talks:
#   - HgLzykU5wc8
```
