Convert documentation to AI-ready skills for coding assistants
Project description
Doc-to-Skill
Автоматический инструмент для скачивания документации и генерации AI-навыков (skills) для Code.
Возможности
- 📥 Скачивание документации - рекурсивный краулинг сайтов с конвертацией в Markdown
- 🔧 Генерация навыков - автоматическое создание SKILL.md для AI-ассистентов
- 🚀 Полный пайплайн - одна команда для установки документации в проект
- 📋 OpenAPI поддержка - парсинг Swagger/OpenAPI спецификаций
Установка
# Установка из локальной директории
pip install -e .
# Или установка зависимостей напрямую
pip install -r requirements.txt
Использование
Скачать документацию
doc-to-skill download https://docs.example.com -o ./docs/example
Сгенерировать навык
doc-to-skill generate ./docs/example --name "Example API"
Полный пайплайн (скачать + сгенерировать + установить)
doc-to-skill install https://docs.example.com ./my-project --name "Example API"
Это создаст:
./my-project/docs/api/example-api/- скачанная документация./my-project/.agent/skills/example-api/- готовый навык
Список установленных навыков
doc-to-skill list-skills
Структура сгенерированного навыка
.agent/skills/example-api/
├── SKILL.md # Краткий overview для AI
├── reference.md # Полный API справочник
└── examples.md # Примеры кода
Пример SKILL.md
---
name: Example API
description: API documentation and reference for Example API
---
# Example API Documentation
## When to Use This Skill
Use this skill when you need to:
- Work with Example API integration
- Implement authentication for Example API
- Find API endpoints and their parameters
## Quick Reference
### Documentation Paths
- **Full Reference**: reference.md
- **Code Examples**: examples.md
- **Raw Documentation**: docs/api/example-api/
### Common Endpoints
- **GET** `/api/users` - Get all users
- **POST** `/api/users` - Create user
...
Опции команд
download
| Опция | Описание | По умолчанию |
|---|---|---|
-o, --output-dir |
Директория для сохранения | ./docs |
-d, --max-depth |
Максимальная глубина обхода | 3 |
-l, --limit |
Максимум страниц | 100 |
generate
| Опция | Описание | По умолчанию |
|---|---|---|
-n, --name |
Имя сервиса/API (обязательно) | - |
-o, --output-dir |
Директория для навыка | .agent/skills/<name> |
install
| Опция | Описание | По умолчанию |
|---|---|---|
-n, --name |
Имя сервиса/API (обязательно) | - |
-d, --max-depth |
Максимальная глубина обхода | 3 |
-l, --limit |
Максимум страниц | 100 |
Лицензия
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
doc_to_skill-0.1.0.tar.gz
(20.9 kB
view details)
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 doc_to_skill-0.1.0.tar.gz.
File metadata
- Download URL: doc_to_skill-0.1.0.tar.gz
- Upload date:
- Size: 20.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
372e79eb39b25b27ed6a2016474320679217ca94f8afc682ae6f66adb2a9a5e9
|
|
| MD5 |
a053f8c6a829a5d463540ce52d0237e3
|
|
| BLAKE2b-256 |
968ca5cfbf506055e968e4e511f49ecd788e14d028d26c009f1b7afd4d226777
|
File details
Details for the file doc_to_skill-0.1.0-py3-none-any.whl.
File metadata
- Download URL: doc_to_skill-0.1.0-py3-none-any.whl
- Upload date:
- Size: 24.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f86a8811b81172d8f776d2b2f562abd9aa096f541639efbdf903f92bb100ac9e
|
|
| MD5 |
745338b26ec64d9a0ddf67fb81c6122c
|
|
| BLAKE2b-256 |
5c050e8ad90db7e44c516fb5c0a6aa54b2d0aeeae082199cdc98c9382900d841
|