mkdocs-media-gallery-plugin

Name	mkdocs-media-gallery-plugin JSON
Version	1.0.0 JSON
	download
home_page	None
Summary	MkDocs plugin providing media galleries with shortcodes
upload_time	2025-08-27 04:15:35
maintainer	None
docs_url	None
author	APinchofDill
requires_python	>=3.8
license	None
keywords	mkdocs image gallery
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

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

```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
```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "mkdocs-media-gallery-plugin",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "mkdocs, image, gallery",
    "author": "APinchofDill",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/b6/9d/275638375c61b20d2689916cbf206e1f59e4a8f0c9a761b9232608cd3248/mkdocs_media_gallery_plugin-1.0.0.tar.gz",
    "platform": null,
    "description": "# MKDOCS Media Galleries \r\n\r\nMkDocs plugin for that adds image and YouTube galleries with shortcodes.\r\n\r\n## Install\r\n\r\n```bash\r\npip install mkdocs-media-gallery-plugin\r\n```\r\n\r\n## Configure (mkdocs.yml)\r\n\r\n```yaml\r\nplugins:\r\n  - search\r\n  - media-gallery:\r\n      images_path: images            # relative to docs_dir\r\n      youtube_links_path: youtube-links.yaml  # relative to docs_dir\r\n      generate_category_pages: true  # auto-generate one page per category\r\n```\r\n\r\n## Shortcodes in Markdown\r\n\r\n- `{{ gallery_preview }}`: Shows preview tiles for each category (folder under images_path)\r\n- `{{ gallery_full category=\"cats\" }}`: Shows full gallery for the given category\r\n- `{{ youtube_gallery }}`: Renders YouTube gallery from YAML (optionally `category=\"...\"`)\r\n\r\n## YouTube data (docs/youtube-links.yaml)\r\n\r\n```yaml\r\n# Either flat list\r\n- https://www.youtube.com/watch?v=ZucM9aw6Qlo\r\n- sHfe3nT5-jk\r\n\r\n# Or categorized\r\nMusic:\r\n- https://www.youtube.com/watch?v=mEK0owuRoks\r\nShows:\r\n- https://www.youtube.com/watch?v=ZucM9aw6Qlo\r\n```\r\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "MkDocs plugin providing media galleries with shortcodes",
    "version": "1.0.0",
    "project_urls": {
        "Homepage": "https://github.com/APinchofDill/mkdocs-media-gallery-plugin"
    },
    "split_keywords": [
        "mkdocs",
        " image",
        " gallery"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "4736ce3c3468aa72332003812c21a937c6ccb132fd4c941c381a856e79b258d0",
                "md5": "37f6f75c6cd42ed6b0dd623cc8f57e5c",
                "sha256": "c639776eeb45b6010ab13487c2163a062e43668a5252c510a23c16d0c5b6c1a0"
            },
            "downloads": -1,
            "filename": "mkdocs_media_gallery_plugin-1.0.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "37f6f75c6cd42ed6b0dd623cc8f57e5c",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 12116,
            "upload_time": "2025-08-27T04:15:34",
            "upload_time_iso_8601": "2025-08-27T04:15:34.391178Z",
            "url": "https://files.pythonhosted.org/packages/47/36/ce3c3468aa72332003812c21a937c6ccb132fd4c941c381a856e79b258d0/mkdocs_media_gallery_plugin-1.0.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "b69d275638375c61b20d2689916cbf206e1f59e4a8f0c9a761b9232608cd3248",
                "md5": "2ce1e0896a7d3ab74281d5938bab9035",
                "sha256": "8991967ea1c3ebc7a3bdebc76e1fe5ef3ce5f16fe06e41ec5081a3399b0e2124"
            },
            "downloads": -1,
            "filename": "mkdocs_media_gallery_plugin-1.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "2ce1e0896a7d3ab74281d5938bab9035",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 10323,
            "upload_time": "2025-08-27T04:15:35",
            "upload_time_iso_8601": "2025-08-27T04:15:35.498030Z",
            "url": "https://files.pythonhosted.org/packages/b6/9d/275638375c61b20d2689916cbf206e1f59e4a8f0c9a761b9232608cd3248/mkdocs_media_gallery_plugin-1.0.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-08-27 04:15:35",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "APinchofDill",
    "github_project": "mkdocs-media-gallery-plugin",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "mkdocs-media-gallery-plugin"
}