mirror of
https://github.com/tradecatlabs/vibe-coding-cn.git
synced 2026-08-15 03:48:04 +00:00
feat: Comprehensive documentation update and claude-skills module enhancement
This commit is contained in:
Vendored
+21
-19
@@ -1,29 +1,31 @@
|
||||
# 🔌 外部集成模块 (External)
|
||||
# 🔌 libs/external:外部集成与第三方工具
|
||||
|
||||
存放第三方工具、外部依赖和集成模块。
|
||||
`libs/external/` 用来收纳第三方工具、外部依赖与集成模块。核心原则是:
|
||||
|
||||
- **尽量原样保留**:避免“魔改后不可升级”
|
||||
- **隔离依赖与风险**:外部工具的依赖不要污染主仓库
|
||||
- **可追溯**:来源、许可证、用法要写清楚
|
||||
|
||||
## 目录结构
|
||||
|
||||
```
|
||||
external/
|
||||
├── prompts-library/ # 提示词库管理工具(Excel ↔ MD 互转)
|
||||
├── my-nvim/ # Neovim 配置
|
||||
└── XHS-image-to-PDF-conversion/ # 小红书图片转 PDF
|
||||
libs/external/
|
||||
├── README.md
|
||||
├── prompts-library/ # 提示词库管理工具(Excel ↔ Markdown)
|
||||
├── my-nvim/ # Neovim 配置(含 nvim-config/)
|
||||
├── XHS-image-to-PDF-conversion/ # 图片合并 PDF 工具
|
||||
└── .gitkeep
|
||||
```
|
||||
|
||||
## 工具说明
|
||||
## 工具清单(入口与文档)
|
||||
|
||||
| 工具 | 用途 | 使用方法 |
|
||||
|------|------|----------|
|
||||
| `prompts-library` | 提示词 Excel/MD 互转 | `python main.py` |
|
||||
| `my-nvim` | Neovim 配置 | 复制到 `~/.config/nvim` |
|
||||
| `XHS-image-to-PDF-conversion` | 图片合并 PDF | `python pdf.py` |
|
||||
- `prompts-library/`:提示词 Excel ↔ Markdown 批量互转与索引生成(详见 [`prompts-library/README.md`](./prompts-library/README.md))
|
||||
- `my-nvim/`:个人 Neovim 配置(详见 [`my-nvim/README.md`](./my-nvim/README.md))
|
||||
- `XHS-image-to-PDF-conversion/`:图片合并 PDF(详见 [`XHS-image-to-PDF-conversion/README.md`](./XHS-image-to-PDF-conversion/README.md))
|
||||
|
||||
## 新增外部工具
|
||||
## 新增外部工具(最小清单)
|
||||
|
||||
```bash
|
||||
mkdir -p libs/external/工具名
|
||||
echo "# 工具说明" > libs/external/工具名/README.md
|
||||
```
|
||||
|
||||
新增时请注明来源、许可证和依赖。
|
||||
1. 创建目录:`libs/external/<tool-name>/`
|
||||
2. 必备文件:`README.md`(用途/入口/依赖/输入输出)、许可证与来源说明(如 `LICENSE` / `SOURCE.md`)
|
||||
3. 依赖约束:尽量使用工具自带的虚拟环境/容器化方式,不影响仓库其他部分
|
||||
4. 文档同步:在本 README 增加一行工具说明,保证可发现性
|
||||
|
||||
Reference in New Issue
Block a user