skills.rest
Fu-Jie
Fu-JieCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

doc-mirror-sync

Mirror plugin READMEs into the docs directory for MkDocs.

286|24|Updated Dec 20, 2025
Search Tags:#documentation#markdown#plugin#docs#scripts#mkdocs#mirror
One-click install
npx skills add https://github.com/Fu-Jie/openwebui-extensions --skill doc-mirror-sync
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: doc-mirror-sync
Source: https://github.com/Fu-Jie/openwebui-extensions/tree/main/.gemini/skills/doc-mirror-sync
Command: npx skills add https://github.com/Fu-Jie/openwebui-extensions --skill doc-mirror-sync

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

Automates the mirroring of plugin READMEs to the official documentation directory (docs/plugins), helping MkDocs sites stay up to date after local edits. The workflow ensures consistency between local plugin documentation and the published docs site with minimal manual steps.

Core Features & Use Cases

  • Mirrors README.md to docs/plugins/{type}/{name}.md for EN content.
  • Mirrors README_CN.md to docs/plugins/{type}/{name}.zh.md when available.
  • Works across multiple plugin types (actions, filters, pipes, pipelines, tools) with a single script.

Quick Start

Run the mirror script to copy all EN and CN READMEs into the docs directory.

Frequently Asked Questions about doc-mirror-sync

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

FAQPage Schema
How do I sync plugin READMEs to my MkDocs documentation directory automatically?▼

To sync plugin READMEs to MkDocs, you can run a script that copies README.md files into the docs/plugins directory, keeping your documentation site up to date after local edits without manual steps.

What is the best way to keep local plugin documentation consistent with a published docs site?▼

The best way to keep plugin documentation consistent is to mirror README files directly into the official docs directory using an automated script, ensuring published content matches local plugin code.

Does the README mirroring script support bilingual CN and EN content?▼

Yes, the README mirroring script supports both EN and CN content by copying README.md for English and README_CN.md for Chinese when available, placing them into the appropriate docs directory.

Can I use this script to mirror documentation across multiple plugin types like actions and filters?▼

You can use the script to mirror documentation across multiple plugin types including actions, filters, pipes, pipelines, and tools, organizing them automatically within the docs/plugins directory.

Will running the sync script modify my original plugin code?▼

Running the sync script will not modify your original plugin code because it relies on a Python script to perform file copy operations only, mirroring the READMEs without altering source files.

Related Skills

Explore More Software Engineering Skills→
openaiopenai
5.0k

plugin-creator

Scaffold Codex plugin directories and generate placeholder plugin.json manifests.

Official
Intermediate
WtydWtyd
9

docs

Organize GitHooks documentation pages with MkDocs and GitHub Actions deployment.

Community
Intermediate
PelekePeleke

llms-txt-generator

Generate llms.txt and llms-full.txt files from MkDocs navigation and markdown content.

Community
Intermediate
1337hero1337hero
1

codebase-documenter

Create beginner-friendly Markdown documentation for codebases using structured templates.

Community
Intermediate