sync-docs

Syncs screenshots and Markdown docs to knowledge base providers via config.yaml.

23|4|Updated Dec 22, 2025
One-click install
npx skills add https://github.com/maxberko/max-doc-ai --skill sync-docs-maxberko
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: sync-docs
Source: https://github.com/maxberko/max-doc-ai/tree/main/.claude/skills/sync-docs
Command: npx skills add https://github.com/maxberko/max-doc-ai --skill sync-docs-maxberko

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This skill automates the synchronization of screenshots and Markdown documentation to knowledge base providers, reducing manual handoffs and ensuring consistent customer-facing content.

Core Features & Use Cases

  • Upload Screenshots to a KB CDN and obtain shareable URLs for embedding in docs.
  • Sync Markdown documentation to provider HTML and publish to Pylon, Zendesk, Confluence, Notion, and more.
  • Automatic provider detection from config.yaml with optional per-operation override for flexibility.

Quick Start

Configure your KB provider in config.yaml, then run the sync-docs workflow to upload screenshots and publish Markdown documentation to your knowledge base.

Frequently Asked Questions about sync-docs

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

FAQPage Schema
How do I sync Markdown documentation to a knowledge base like Confluence or Zendesk?

You can sync Markdown documentation to Confluence or Zendesk by running the sync-docs workflow, which automatically converts Markdown to provider-specific HTML and publishes articles with state tracking and collection assignment.

How do I upload screenshots to a knowledge base CDN and get shareable URLs?

To upload screenshots to a knowledge base CDN, use the upload mode in the sync-docs workflow; it pushes images to the CDN and generates shareable URLs for embedding directly in your documentation.

Can I automatically detect my knowledge base provider from configuration?

Yes, automatic knowledge base provider detection is supported by reading your config.yaml file, while also allowing optional per-operation overrides to dynamically switch providers like Pylon or Notion during specific sync tasks.

What is the best way to automate publishing Markdown docs to multiple knowledge base providers?

The best way to automate publishing Markdown docs to multiple knowledge base providers is using a sync workflow that handles provider-specific HTML conversion, state tracking, and collection assignment across platforms like Notion and Pylon.

Does this documentation sync workflow require any external dependencies?

No external dependencies are required to run the documentation sync workflow; it operates independently using internal scripts to manage uploads, provider detection, and article creation across supported knowledge base platforms.

Why sync Markdown documentation instead of manually copying content to a knowledge base?

Syncing Markdown documentation automates manual handoffs to knowledge bases, ensuring consistent customer-facing content by standardizing provider-specific HTML conversion and tracking article state across Pylon, Zendesk, Confluence, and Notion.