Mirror official docs (via llms.txt) as plain Markdown for LLM ingestion and RAG.
Project description
llms-mirror
Mirror an official documentation site (via its llms.txt index) as plain Markdown, organized 1:1 by URL path, ready for LLM ingestion, RAG pipelines, and knowledge graphs.
Pure standard library — no dependencies. Mirrors Midtrans, Clerk, Canva, Xendit, and Stripe docs with one command.
Install
pip install llms-mirror
Usage
# Full pipeline: crawl site -> Markdown tree -> llms-full.txt + README + INDEX
llms-mirror mirror https://stripe.com/docs/llms.txt --out stripe-docs
# From an already-mirrored directory, rebuild artifacts
llms-mirror full # regenerate llms-full.txt
llms-mirror index # regenerate README.md + INDEX.md
Options:
| Flag | Meaning |
|---|---|
--out DIR |
output directory (default docs) |
--workers N |
parallel downloads (default 8) |
--redact |
replace Stripe-style API keys (sk_test_...) with REPLACE_ME |
--strip-fm |
strip YAML frontmatter from pages |
--no-llms-full |
skip the single-file corpus |
--no-git |
skip git init + commit |
Output
docs/
├── llms.txt # original official index (verbatim)
├── llms-full.txt # entire corpus in one file
├── INDEX.md # every page + first heading
├── README.md # landing page
├── missing.md # pages that failed to download (404 etc.)
└── <path>/.../*.md # mirrored pages, URL structure preserved
Examples
- https://github.com/naelrudd/midtrans-docs-llm-agents (589 pages)
- https://github.com/naelrudd/clerk-docs-llm-agents (2343 pages)
- https://github.com/naelrudd/xendit-docs-llm-agents (336 pages)
- https://github.com/naelrudd/stripe-docs-llm-agents (473 pages)
- https://github.com/naelrudd/canva-docs (392 pages)
License
MIT
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file llms_mirror-0.1.0.tar.gz.
File metadata
- Download URL: llms_mirror-0.1.0.tar.gz
- Upload date:
- Size: 5.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/7.0.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
333d7b74d134e05ef2120f217de16912bd4561ed7e55e706573b66d62c524271
|
|
| MD5 |
9668a416d5eead4806bca6beeb85afd3
|
|
| BLAKE2b-256 |
f684fe860688e0efda356ad5cfd278e7accf72fe926fcd5a045a310de5ae80dd
|
File details
Details for the file llms_mirror-0.1.0-py3-none-any.whl.
File metadata
- Download URL: llms_mirror-0.1.0-py3-none-any.whl
- Upload date:
- Size: 6.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/7.0.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
fd867c602a010fdea087a02f184b3e4c90698113569e8de7a0175dddfb1d9f28
|
|
| MD5 |
664ca092764d83d9646a4db41bd4c5d0
|
|
| BLAKE2b-256 |
3858fda714551d3eeba22802f52b6853175e31553d5611af85039097cf798e1b
|