---
title: "Farm Docs"
locale: "zh"
version: "current"
canonicalUrl: "https://farmfe.org/zh/docs/farm-docs/overview"
publicationStatus: "prerelease"
---

<a id="farm-docs"></a>
# Farm Docs


**预发布文档。** Farm Docs 正随 v2 准备发布。


Farm Docs 是基于 Farm 的文档网站框架。Rust 实现 Markdown/MDX 解析、内容校验、路由规划与编译扩展；React 渲染默认主题和浏览器界面；Node 负责开发、静态生成与预览的编排。


Farm v2 官网使用这一框架。它与通用应用的 Farm 构建配置不同，不依赖 Docusaurus 运行时。


<a id="已实现的能力"></a>
## 已实现的能力


- Markdown/MDX 文档集合与生成式导航。
- 显式的语言和版本集合，以及生成的页面切换目标。
- React 主题插槽、侧栏、正文目录、代码块与响应式导航。
- 注册到 Farm CLI 的开发、静态构建与本地预览工作流。
- 原生校验重复路由、缺失引用与不可用内容。


默认主题为 ` @farmfe/docs-theme-default `。网站品牌与专属页面布局放在站点层，通用阅读组件放在主题层，编译扩展放在原生 Rust 插件层。


<a id="继续阅读"></a>
## 继续阅读


[使用指南](</zh/docs/farm-docs/usage>) 介绍目录、配置、主题、构建与预览。Farm Docs 不会自动发布包或部署网站。


<a id="发行注意事项"></a>
## 发行注意事项


框架仍在 v2 工作区中开发。本地源码构建成功不代表匹配的正式包与各平台原生产物已经发布。外部安装前，需要核对发行版本、可选原生依赖和隔离消费者测试结果。部署不能用旧包冒充匹配版本，也不能静默回退到从源码编译整个依赖链。


<a id="配置与定制参考"></a>
## 配置与定制参考


完整字段、默认值与校验规则见[配置参考](</zh/docs/farm-docs/configuration>)；CSS tokens、React 槽位、alias 与 Rust 代码渲染见[主题定制](</zh/docs/farm-docs/theme-customization>)。