DocSearch 项目
本页面由 PageTurner AI 翻译（测试版）。未经项目官方认可。 发现错误？ 报告问题 →
如果您在本站未能找到问题答案，此页面将为您提供帮助。若仍有疑问，欢迎通过 Discord 与我们交流或联系技术支持团队。
关于 DocSearch x Algolia Crawler 的问题，请参阅我们的 Crawler 常见问题。
我需要安装哪些组件？
您只需在前端实现 DocSearch，使用应用部署后邮件收到的凭证即可。
DocSearch 基于 Algolia Crawler 构建，该服务提供可视化控制台用于创建、监控、编辑和启动爬虫程序。相关问题请参考 Crawler 常见问题。
费用是多少？
完全免费！
我们深知搜索基础设施成本并非所有开源项目都能承担。因此我们决定为所有人免费提供 DocSearch。唯一的回报要求是保留搜索结果旁显示的"由 Algolia 提供搜索"标识。
若您无法满足此要求，可开通独立 Algolia 账户并自主运行 DocSearch。但需注意：根据文档规模，您可能需要付费账户（免费账户最多支持 10,000 条记录）。
你们收集哪些数据？
我们提取您网站的 HTML 标记数据，将其转换为定制 JSON 格式（非原始 HTML）。这些数据将存入 Algolia DocSearch 索引。配置文件中的选择器决定了抓取的数据范围。
作为网站所有者，您还可访问专属 Algolia 应用：查看网站索引状态、匿名搜索行为分析数据、团队管理功能等。
数据存储在哪里？
DocSearch 数据存储在 Algolia 全球分布式服务器。详见服务器规格说明，完整信息请参阅隐私政策。
如何升级 DocSearch 应用？
根据您的需求，我们有多种升级方案！
升级方案一：为现有 DocSearch 添加特定功能（如 Rules）
联系我们，我们将竭诚协助！
升级方案二：移除 Algolia 标识
此操作将使您失去免费使用 DocSearch 的资格。我们提供开源旧版 DocSearch Crawler供您自主托管，或使用API 客户端。但需新建 Algolia 应用并承担相应费用（免费账户仅支持 10,000 条记录）。
升级方案三：Algolia 体验卓越，希望全站采用
这太棒了！请联系我们的销售团队，他们能帮助您选择最合适的方案。创建新应用后，您只需将爬虫配置复制粘贴到新应用的爬虫中即可。
能否在非文档页面使用DocSearch？
我们提供的免费DocSearch服务仅会爬取开源项目的文档页面或技术博客。若需在网站其他部分使用，您需要创建自己的Algolia账户并选择以下任一方式：
-
自行运行DocSearch爬虫
-
使用我们的其他框架集成或API客户端
能否索引代码示例？
可以，但不建议这样做。
代码示例虽是人类理解方法用法的好方式，但通常包含大量重复的样板代码，这些噪音会降低搜索结果质量。
我喜欢的文档网站未使用DocSearch，该怎么办？
我们很乐意提供帮助！
如果您喜爱的工具文档网站尚未使用DocSearch，建议在其代码仓库提交issue说明DocSearch的益处。也欢迎在Discord通知我们，我们将全力协助。
这个网站是如何构建的？
我们使用Docusaurus v2构建本网站。特别感谢给予我们巨大启发的Endi，谨此致敬这位永远属于DocSearch项目的杰出伙伴。愿逝者安息！
能否在代码仓库公开分享apiKey？
DocSearch团队提供的apiKey是仅限搜索的密钥，可安全公开。您可将其纳入版本控制系统（如git）。若自行运行爬虫，请确保创建仅搜索密钥，且切勿共享管理员密钥。
为何控制台的API密钥与邮件不同？
每个Algolia应用都有默认的"Search API Key"，可在控制台查看。该密钥允许您列出索引、查看设置并在所有索引上执行搜索。对于DocSearch应用，我们在确认邮件中提供仅限您DocSearch索引范围的搜索密钥。如需找回邮件中的API密钥，请联系技术支持团队。
如何轮换API密钥？
请联系我们的技术支持团队。
能否在同一个Algolia应用中管理多个项目？
我们建议每个项目使用独立的 Algolia 应用。如需在其他项目中使用 DocSearch，请提交申请。
原因是什么？
初始申请的项目信息将贯穿应用部署全过程：
-
API密钥的作用域
-
Algolia应用/爬虫的命名
-
生成的索引名称
-
爬虫的允许域名配置
这样在寻求技术支持时，我们能更精准地定位问题范围。
技术支持
请注意：虽然 Algolia 不直接提供 DocSearch 的技术支持，但以下产品的相关问题可联系我们：
如遇 DocSearch UI 库相关问题，请提交 GitHub issues