docs-sync

Crawl official framework websites to generate structured Markdown usage guides.

Updated Feb 19, 2026
One-click install
npx skills add https://github.com/walker-hzx/AI-Assistant --skill docs-sync-walker-hzx
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-sync
Source: https://github.com/walker-hzx/AI-Assistant/tree/main/skills/docs-sync
Command: npx skills add https://github.com/walker-hzx/AI-Assistant --skill docs-sync-walker-hzx

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

自动从官网爬取前端框架/组件库文档,生成结构化的使用指南。

Core Features & Use Cases

  • 自动分析官网结构,定位组件/API 文档的位置。
  • 针对该框架生成爬虫脚本(Python + Playwright)并执行数据抓取。
  • 将爬取结果整理为结构化 Markdown 文档,便于智能读取和跨项目复用。

Quick Start

请提供框架名称和官网地址以开始文档同步。

Frequently Asked Questions about docs-sync

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

FAQPage Schema
How do I crawl official framework documentation to generate structured Markdown?

You can crawl official framework documentation to generate structured Markdown by analyzing the site structure, generating a Playwright-based crawler, and outputting ready-to-use docs with index.md and components/ directories.

Can I use Playwright to scrape web documentation for multi-project reuse?

Yes, Playwright is used to scrape web documentation for multi-project reuse. The process generates framework-specific crawlers that extract API and component docs, converting them into structured Markdown for cross-project adoption.

What is the best way to automate onboarding guide generation for frontend component libraries?

The best way to automate onboarding guide generation for frontend component libraries is to analyze official websites, locate component documentation, and execute automated crawlers to produce structured Markdown usage guides.

Do I need to provide a framework name and website URL to start syncing docs?

Yes, you need to provide the framework name and official website URL to start syncing docs. This input allows the tool to analyze the site structure and generate the corresponding Playwright crawler.

Does docs-sync work with any frontend framework documentation?

Docs-sync works with frontend framework documentation by generating a tailored crawler for the provided official website. It analyzes the specific site structure to accurately locate and extract API and component documentation.

Why are my scraped docs not structured properly for framework adoption?

Scraped docs may lack proper structure if the site analysis fails to locate component documentation accurately. Generating framework-specific Playwright crawlers ensures the output is structured Markdown with proper index.md and components/ directories.