mkdocs-video
Decision gist · record as of 2026-08-14
Yes, if your documentation is stable and you need simple video embedding in MkDocs. The low install friction and permissive license make it straightforward to add. However, be aware the project is abandoned; install it only if you can tolerate no future updates and your MkDocs version and video needs are unlikely to change significantly.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires mkdocs and lxml as runtime dependencies; MkDocs project must be configured to load plugins.
- Low install friction with a pure-Python wheel.
- However, the project is archived and abandoned as of January 2024, with no maintenance for over a year; rely on it only if your MkDocs setup and video needs remain stable.
License · maintenance · safety
MIT (permissive) — MIT license permits free use, modification, and distribution with minimal restrictions; suitable for most projects.
last release 2023-03-17 (1246 days) · last repo commit 2024-01-04 · 83 stars · archived
0 known vulnerabilities (OSV.dev, 2026-08-14) · 180,808 downloads/mo, #10,140 on PyPI
Alternatives
Verify before relying
pip install mkdocs-video
# In mkdocs.yml:
plugins:
- mkdocs-video
# In your Markdown:
- Whether the plugin remains compatible with recent MkDocs versions given its abandoned status since early 2024.
- Support for modern video codecs and streaming services beyond the documented examples (YouTube, Vimeo, Dailymotion, Facebook).
- Behavior of video autoplay, loop, and muted attributes across different browsers and their autoplay policies.
What it is and what it does
mkdocs-video is a MkDocs plugin that lets you embed videos directly into your documentation pages using a simple Markdown syntax. Instead of writing raw HTML, you use a marked image syntax (by default ``) and the plugin converts it to an HTML5 `<video>` tag or an `<iframe>` for embedded services like YouTube or Vimeo. The plugin depends on mkdocs and lxml, and runs as a pure-Python wheel with low installation friction.
You configure it globally in `mkdocs.yml` to set default styles, video attributes (autoplay, loop, muted, controls), and the marker string itself. Individual videos can override global settings using the Attribute Lists Markdown extension. The project is archived and has not been maintained since January 2024, so it works best in stable documentation environments where you don't expect frequent MkDocs or video-handling updates.
Use it for
- Add tutorial or demo videos to technical documentation without writing HTML.
- Embed YouTube, Vimeo, or Dailymotion videos alongside written guides using standard Markdown syntax.
- Create responsive video containers with consistent styling across all documentation pages via global configuration.
- Host local video files (mp4, ogg) alongside documentation content and reference them with relative paths.
- Fine-tune individual video playback behavior (autoplay, muted, controls) per video using Markdown attributes.
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes, if your documentation is stable and you need simple video embedding in MkDocs.
The low install friction and permissive license make it straightforward to add. However, be aware the project is abandoned; install it only if you can tolerate no future updates and your MkDocs version and video needs are unlikely to change significantly.
Install
mkdocs-video on PyPI
Before you install
Low install friction with a pure-Python wheel. However, the project is archived and abandoned as of January 2024, with no maintenance for over a year; rely on it only if your MkDocs setup and video needs remain stable.
Requires mkdocs and lxml as runtime dependencies; MkDocs project must be configured to load plugins.
License in practice
MIT license permits free use, modification, and distribution with minimal restrictions; suitable for most projects.
Quickstart
pip install mkdocs-video
# In mkdocs.yml:
plugins:
- mkdocs-video
# In your Markdown:
Verify before relying
- Whether the plugin remains compatible with recent MkDocs versions given its abandoned status since early 2024.
- Support for modern video codecs and streaming services beyond the documented examples (YouTube, Vimeo, Dailymotion, Facebook).
- Behavior of video autoplay, loop, and muted attributes across different browsers and their autoplay policies.
Package facts
| License | MIT permissive |
| Python support | Supports the current Python release >=3.6 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 2 packagesmkdocslxml |
| Maintenance | Abandoned 1,246 days since the last release |
| Last repo commit | repository archived |
| First released | |
| Downloads | 180,808 / month, #10,140 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
Evidence: mkdocs_video-1.5.0-py3-none-any.whl
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “mkdocs video embedding”
- mkdocs-videoA MkDocs plugin that embeds videos in documentation pages using…
- mkdocs-plugin-inline-svgA MkDocs plugin that replaces SVG image references in Markdown with…
- mkdocs-drawioA MkDocs plugin that embeds interactive Drawio diagrams directly into…
Give your agent the search over MCP, or paste the wish link into any chat.
More Documentation packages
Docutils converts plaintext documentation in reStructuredText format into multiple output formats including HTML, XML, and LaTeX using a modular processing system.
Sphinx generates professional documentation from reStructuredText source files, producing HTML, PDF, EPUB, and other formats with automatic cross-references, code highlighting, and hierarchical navigation.
Griffe extracts the complete structure and signatures of Python programs to generate API documentation or detect breaking changes in your project's public API.
Install it if you need to programmatically inspect Python code structure, generate API docs, or enforce API stability in CI.
A Sphinx extension that outputs documentation in serialized HTML formats (JSON and pickle) alongside standard HTML.
Alabaster is a clean, responsive Sphinx theme for documentation that requires Python 3.10 or newer and Sphinx 6.2 or newer.
A Sphinx extension that generates HTML help files from reStructuredText documentation source.
See also mkdocs-include-markdown-plugin · mkdocs-link-marker · mkdocs-plugin-inline-svg · mkdocs-table-reader-plugin · mkdocs-llmstxt · mkdocs-htmlproofer-plugin · mkdocs-embed-external-markdown · mkdocs-drawio · mkdocs-meta-manager · mkdocs-glightbox