article
README
🚀 llmctx
llmctx 能够将技术文档转换为适合人工智能处理的格式。它通过预设的 URL,提供了一种简单的方式来访问流行框架和库文档的精简、适合大语言模型(LLM)的版本。这使得开发者能够更轻松地使用 Cursor 或 Zed 等 AI 编码助手,并从官方文档源获取准确、最新的上下文信息。
🚀 快速开始
llmctx 可让你便捷地获取优化后的文档,只需访问预设的 URL 即可。
✨ 主要特性
- 预设 URL,可快速访问针对 LLM 优化的文档。
- 内容定期从官方文档更新。
📦 安装指南
文档未提及安装步骤,暂不展示。
💻 使用示例
基础用法
访问 llmctx.com 查看所有预设。
高级用法
若要添加新的预设,可按以下步骤操作:
- 复刻此仓库。
- 打开
src/lib/presets.ts文件。 - 向
presets对象添加一个新条目,结构如下:
[presetKey]: {
title: 'Preset Title',
owner: 'github-owner',
repo: 'github-repo',
glob: ['**/*.md', '**/*.mdx', '!**/excluded/**'], // 必需,支持通配符模式
prompt: 'Optional prompt for additional context'
}
- 创建一个包含你所做更改的拉取请求。
glob 字段支持通配符模式,可提供灵活的文件匹配:
- 使用
**/*.md匹配任何子目录中的所有 Markdown 文件。 - 使用
**/*.mdx匹配任何子目录中的所有 MDX 文件。 - 使用
!pattern排除匹配该模式的文件/目录。 - 组合模式以进行细粒度控制,例如
['**/*.md', '**/*.mdx', '!**/excluded/**']。 - 模式按顺序处理,因此你可以先包含文件,然后排除特定文件。
请确保文档源可靠且维护活跃。
📚 详细文档
功能请求
- [x] 合并多个文档源(例如,https://llmctx.com/svelte,sveltekit)
- [ ] 创建常用框架和库的“组合”
- [ ] 实现一个复选框 UI,用于选择预设并根据所选文档生成自定义 URL
🔧 技术细节
文档未提供相关技术细节,暂不展示。
📄 许可证
文档未提及许可证信息,暂不展示。
微信扫一扫