docs-crawler

Solid

Crawl an entire documentation or design-system website into one LLM-ready Markdown corpus. Discovers every page from the site's sitemap.xml (with a same-origin link-following fallback when there is no sitemap), extracts each page's main content as clean Markdown, downloads each page's images (and inline base64 images) into a local folder referenced by relative paths, and renders JavaScript-heavy pages with a headless browser. Use this whenever someone wants the WHOLE of a multi-page docs site, design-system site, API reference, component library, or knowledge base turned into Markdown — for example "crawl this docs site", "turn this design system site into markdown", "make an LLM or RAG corpus from these docs", "mirror the entire documentation", "archive the whole knowledge base", or "give an AI the full X documentation". It applies even when the user never says the word "crawl" — any request to capture, ingest, archive, or convert a whole site's documentation pages into text fits. The design-md skill also ca

Data & Documents 45 stars 4 forks Updated 2 days ago MIT

Install

View on GitHub

Quality Score: 83/100

Stars 20%
55
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# docs-crawler Crawl a documentation website into a single Markdown corpus that an LLM can consume as context. ## When to use The user wants to capture a multi-page documentation, design-system, or reference site as Markdown — to feed an LLM, archive it, or research a design system. This skill is also invoked by the `design-md` skill's research phase. ## Inputs - **Site URL** (required) — the documentation site, e.g. `https://socarframe.socar.kr/`. Any page on the site works; page discovery starts from the site's `sitemap.xml`. - **Output directory** (optional) — where to write the corpus. Defaults to `./{host}-docs/` in the current working directory. If the user has not provided a URL, ask for one — do not guess. ## Running the crawl From the repository root: ``` pnpm crawl:docs <site-url> [--out <dir>] [--external-images] ``` Equivalent direct form: ``` pnpm exec tsx .claude/skills/docs-crawler/scripts/crawl.ts <site-url> [--out <dir>] ``` The engine discovers pages via `sitemap.xml` (falling back to same-origin link-following), fetches each page, extracts the main content, and converts it to Markdown. It prints per-page progress and a final summary line. By default it also **localizes images**: every external image and inline base64 `data:` image is downloaded into `crawl/images/` and the Markdown is rewritten to relative paths, so the corpus is self-contained for renderers that can't fetch external URLs (Claude Design, offline previews). Pass `--externa...

Details

Author
CaesiumY
Repository
CaesiumY/ko-design-md
Created
4 months ago
Last Updated
2 days ago
Language
HTML
License
MIT

Similar Skills

Semantically similar based on skill content — not just same category