# Crib 文档

> Crib 的安装、搜索、阅读、资料库管理与集成说明。

---

LLMS 索引： [llms.txt](/llms.txt)

---

> [!NOTE] 文档对应开发构建
>
> Crib 还没有公开安装包。这里描述的是当前开发构建的行为，正式发布前可能还会调整；进度见[发布状态](/docs/intro/status/)。

## 常用入口 {#start}

- [安装与首次启动](/docs/guide/install/)

  两个版本的区别，第一次打开时会发生什么。

- [搜索](/docs/guide/search/)

  版本前缀、筛选条件、符号与中文检索。

- [阅读与双语对照](/docs/guide/reader/)

  切到另一种语言的同一节，或两栏并排。

- [管理资料库](/docs/library/manage/)

  启用、停用、导入和恢复文档版本。

- [本地 API 与 MCP](/docs/integrations/mcp/)

  让编辑器和 AI 客户端查询离线文档。

- [发布状态](/docs/intro/status/)

  已经完成什么，正式发布前还差什么。
{.cards}

## 文档地图 {#map}

### 简介 {#intro}

Crib 是什么、收录哪些内容、怎样工作、现在到了哪一步。

[Crib 是什么](/docs/intro/overview/) · [收录内容](/docs/intro/content/) · [工作原理](/docs/intro/architecture/) · [发布状态](/docs/intro/status/)

### 使用指南 {#guide}

从安装到日常使用的每一个功能。

[安装与首次启动](/docs/guide/install/) · [搜索](/docs/guide/search/) · [阅读与双语对照](/docs/guide/reader/) · [笔记、书签与本地更正](/docs/guide/notes/) · [片段](/docs/guide/snippets/) · [快捷键](/docs/guide/shortcuts/)

### 资料库 {#library}

获取和管理文档版本，更新、回滚和恢复，以及资料包格式。

[管理资料库](/docs/library/manage/) · [版本与别名](/docs/library/versions/) · [下载、更新与恢复](/docs/library/updates/) · [资料包格式](/docs/library/packs/)

### 集成 {#integrations}

让其他程序使用 Crib 里的文档。

[本地 API](/docs/integrations/local-api/) · [MCP](/docs/integrations/mcp/) · [系统服务与全局快捷键](/docs/integrations/services/) · [深链接](/docs/integrations/deep-links/)

### 参考 {#reference}

数据存放位置、内容来源和常见问题。

[用户数据与迁移](/docs/reference/data/) · [来源与许可](/docs/reference/sources/) · [常见问题](/docs/reference/faq/)

---

本节页面：

- [简介](/docs/intro/): Crib 是什么、收录哪些内容、怎样工作、现在到了哪一步。
- [使用指南](/docs/guide/): 安装与首次启动、搜索语法、双语阅读、笔记与本地更正、片段和快捷键。
- [资料库](/docs/library/): 获取和管理文档版本，更新、回滚和恢复，以及 .crib 资料包格式。
- [集成](/docs/integrations/): 本地 API、MCP、系统服务、全局快捷键和 crib:// 深链接。
- [参考](/docs/reference/): 用户数据目录、从 PGDash 迁移、来源与许可、常见问题。