skills.rest
miethe
mietheCOMMUNITY
Explore all skills by this author →
Website𝕏@MietheGitHub

publish-demo

Publish MOV, MP4, and GIF demos as MkDocs documentation pages.

Updated May 3, 2026
Search Tags:#documentation#navigation#video conversion#frontmatter#mkdocs#content indexing#demo publishing
One-click install
npx skills add https://github.com/miethe/boxbrain-2 --skill publish-demo
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: publish-demo
Source: https://github.com/miethe/boxbrain-2/tree/main/.claude/skills/publish-demo
Command: npx skills add https://github.com/miethe/boxbrain-2 --skill publish-demo

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires PyYAML, ffmpeg, and includes scripts (resource) components.

What problem does it solve?

This Skill removes the repetitive work of turning raw demo recordings into consistent, discoverable MkDocs documentation pages.

Core Features & Use Cases

  • Asset Normalization: Converts MOV recordings to web-friendly MP4 files and moves media to the canonical documentation asset directory.
  • Page Drafting: Publishes hand-written Markdown pages or drafts demo pages from YAML sidecar metadata.
  • Navigation and Indexing: Rebuilds the demos navigation and adds frontmatter-driven cards to the demo index.
  • Validation: Directs the workflow to run a strict MkDocs build and surfaces conversion failures without rolling back published files.
  • Use Case: Drop a screen recording and its metadata into the demo inbox, then publish a finished, indexed documentation page with the appropriate Web or CLI placement.

Quick Start

Use the publish-demo skill to publish all recordings currently waiting in the demo inbox, regenerate the navigation and index, and validate the MkDocs site.

Frequently Asked Questions about publish-demo

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I convert MOV recordings to MP4 for MkDocs documentation?▼

To convert MOV recordings to MP4 for MkDocs, you can use a tool that normalizes assets and moves media to your documentation directory using ffmpeg. This ensures your web-friendly MP4 files are ready for publishing.

Can I generate MkDocs pages from YAML frontmatter sidecars?▼

Yes, you can generate MkDocs pages from YAML frontmatter sidecars by drafting demo pages directly from the metadata. This approach creates structured documentation pages without requiring hand-written Markdown content.

What is the best way to index demo videos in MkDocs navigation?▼

The best way to index demo videos in MkDocs is to use a workflow that rebuilds the navigation and adds frontmatter-driven cards to the demo index automatically. This makes screen recordings discoverable on your site.

Do I need ffmpeg installed to publish MP4 and GIF demos to my documentation site?▼

Yes, you need ffmpeg installed along with Python and PyYAML to publish MP4 and GIF demos. These dependencies are required for metadata parsing, asset handling, and MOV to MP4 conversion.

Why does my MkDocs build fail after adding new video demos?▼

MkDocs builds may fail after adding video demos due to metadata or asset conversion errors. A strict build validation process surfaces these failures without rolling back the published files, allowing you to fix the issues.

Related Skills

Explore More Content & Communication Skills→
simotasimota
68

Reel

Create terminal recordings and generate GIF, MP4, and WebM videos from .tape scripts.

Community
Advanced
ThalesGroupThalesGroup
19

docs-publish-github-pages

Inspect and patch GitHub Pages docs publishing workflows.

Official
Advanced
Unique-AGUnique-AG
5

entangled-mkdocs

Generate annotated Markdown pages and update navigation for Entangled MkDocs sites.

Official
Intermediate
digitalsambadigitalsamba
1.9k

ffmpeg

Automates FFmpeg media processing to convert, resize, compress, and extract audio for Remotion projects.

Official
Advanced