docs: add llms.txt support documentation
This commit is contained in:
@@ -8,6 +8,8 @@
|
|||||||
pip3 install requests beautifulsoup4
|
pip3 install requests beautifulsoup4
|
||||||
```
|
```
|
||||||
|
|
||||||
|
> **Note:** Skill_Seekers automatically checks for llms.txt files first, which is 10x faster when available.
|
||||||
|
|
||||||
### Step 2: Run the Tool
|
### Step 2: Run the Tool
|
||||||
|
|
||||||
**Option A: Use a Preset (Easiest)**
|
**Option A: Use a Preset (Easiest)**
|
||||||
|
|||||||
@@ -6,7 +6,7 @@
|
|||||||
[](https://opensource.org/licenses/MIT)
|
[](https://opensource.org/licenses/MIT)
|
||||||
[](https://www.python.org/downloads/)
|
[](https://www.python.org/downloads/)
|
||||||
[](https://modelcontextprotocol.io)
|
[](https://modelcontextprotocol.io)
|
||||||
[](tests/)
|
[](tests/)
|
||||||
[](https://github.com/users/yusufkaraaslan/projects/2)
|
[](https://github.com/users/yusufkaraaslan/projects/2)
|
||||||
|
|
||||||
**Automatically convert any documentation website into a Claude AI skill in minutes.**
|
**Automatically convert any documentation website into a Claude AI skill in minutes.**
|
||||||
@@ -34,6 +34,7 @@ Skill Seeker is an automated tool that transforms any documentation website into
|
|||||||
## Key Features
|
## Key Features
|
||||||
|
|
||||||
### 🌐 Documentation Scraping
|
### 🌐 Documentation Scraping
|
||||||
|
- ✅ **llms.txt Support** - Automatically detects and uses LLM-ready documentation files (10x faster)
|
||||||
- ✅ **Universal Scraper** - Works with ANY documentation website
|
- ✅ **Universal Scraper** - Works with ANY documentation website
|
||||||
- ✅ **Smart Categorization** - Automatically organizes content by topic
|
- ✅ **Smart Categorization** - Automatically organizes content by topic
|
||||||
- ✅ **Code Language Detection** - Recognizes Python, JavaScript, C++, GDScript, etc.
|
- ✅ **Code Language Detection** - Recognizes Python, JavaScript, C++, GDScript, etc.
|
||||||
@@ -60,7 +61,7 @@ Skill Seeker is an automated tool that transforms any documentation website into
|
|||||||
- ✅ **Caching System** - Scrape once, rebuild instantly
|
- ✅ **Caching System** - Scrape once, rebuild instantly
|
||||||
|
|
||||||
### ✅ Quality Assurance
|
### ✅ Quality Assurance
|
||||||
- ✅ **Fully Tested** - 142 tests with 100% pass rate
|
- ✅ **Fully Tested** - 207 tests with 100% pass rate
|
||||||
|
|
||||||
## Quick Example
|
## Quick Example
|
||||||
|
|
||||||
@@ -139,6 +140,7 @@ graph LR
|
|||||||
G --> H[Upload to Claude AI]
|
G --> H[Upload to Claude AI]
|
||||||
```
|
```
|
||||||
|
|
||||||
|
0. **Detect llms.txt** - Checks for llms-full.txt, llms.txt, llms-small.txt first
|
||||||
1. **Scrape**: Extracts all pages from documentation
|
1. **Scrape**: Extracts all pages from documentation
|
||||||
2. **Categorize**: Organizes content into topics (API, guides, tutorials, etc.)
|
2. **Categorize**: Organizes content into topics (API, guides, tutorials, etc.)
|
||||||
3. **Enhance**: AI analyzes docs and creates comprehensive SKILL.md with examples
|
3. **Enhance**: AI analyzes docs and creates comprehensive SKILL.md with examples
|
||||||
|
|||||||
@@ -344,3 +344,23 @@ cat output/godot/SKILL.md # Should have real code examples
|
|||||||
cat output/godot/references/index.md # Should show categories
|
cat output/godot/references/index.md # Should show categories
|
||||||
ls output/godot/references/ # Should have category .md files
|
ls output/godot/references/ # Should have category .md files
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## llms.txt Support
|
||||||
|
|
||||||
|
Skill_Seekers automatically detects llms.txt files before HTML scraping:
|
||||||
|
|
||||||
|
### Detection Order
|
||||||
|
1. `{base_url}/llms-full.txt` (complete documentation)
|
||||||
|
2. `{base_url}/llms.txt` (standard version)
|
||||||
|
3. `{base_url}/llms-small.txt` (quick reference)
|
||||||
|
|
||||||
|
### Benefits
|
||||||
|
- ⚡ 10x faster (< 5 seconds vs 20-60 seconds)
|
||||||
|
- ✅ More reliable (maintained by docs authors)
|
||||||
|
- 🎯 Better quality (pre-formatted for LLMs)
|
||||||
|
- 🚫 No rate limiting needed
|
||||||
|
|
||||||
|
### Example Sites
|
||||||
|
- Hono: https://hono.dev/llms-full.txt
|
||||||
|
|
||||||
|
If no llms.txt is found, automatically falls back to HTML scraping.
|
||||||
|
|||||||
Reference in New Issue
Block a user