@@ -787,39 +787,39 @@ page-actions:
787787` ` `
788788
789789<ParamField path="page-actions.default" type="string" required={false} toc={true}>
790- The default page action to display. Options : ` copy-page` , `view-as-markdown`, `ask-ai`, `chatgpt`, `claude`, `claude-code`, `cursor`, `vscode`.
790+ 默认显示的页面操作。可选值: `copy-page`、 `view-as-markdown`、 `ask-ai`、 `chatgpt`、 `claude`、 `claude-code`、 `cursor`、 `vscode`。
791791</ParamField>
792792
793793<ParamField path="page-actions.options.copy-page" type="boolean" required={false} default="true" toc={true}>
794- When enabled, displays a button that allows users to copy the entire page content to their clipboard for easy sharing or reference. To control what content appears in the copied output, use [`<llms-ignore>`](/learn/docs/ai-features/customize-llm-output#content-for-humans-only) tags.
794+ 启用时会显示一个按钮,允许用户将整个页面内容复制到剪贴板,便于分享或参考。如需控制复制输出中包含哪些内容,请使用 [`<llms-ignore>`](/learn/docs/ai-features/customize-llm-output#content-for-humans-only) 标签。
795795</ParamField>
796796
797797<ParamField path="page-actions.options.view-as-markdown" type="boolean" required={false} default="true" toc={true}>
798- When enabled, displays a button that allows users to view the raw Markdown source of the current page. Users can also [view Markdown by appending `.md` to the page URL ](/learn/docs/developer-tools/view-markdown). To control what content appears in the Markdown output, use [`<llms-ignore>`](/learn/docs/ai-features/customize-llm-output#content-for-humans-only) tags.
798+ 启用时会显示一个按钮,允许用户查看当前页面的原始 Markdown 源代码。用户也可以[在页面 URL 后追加 `.md` 来查看 Markdown ](/learn/docs/developer-tools/view-markdown)。如需控制 Markdown 输出中包含哪些内容,请使用 [`<llms-ignore>`](/learn/docs/ai-features/customize-llm-output#content-for-humans-only) 标签。
799799</ParamField>
800800
801801<ParamField path="page-actions.options.ask-ai" type="boolean" required={false} default="true" toc={true}>
802- When enabled, displays an "Ask AI" button that allows users to ask questions about the page content using AI-powered assistance.
802+ 启用时会显示一个 "Ask AI"按钮,允许用户使用 AI 助手就页面内容进行提问。
803803</ParamField>
804804
805805<ParamField path="page-actions.options.chatgpt" type="boolean" required={false} default="true" toc={true}>
806- Controls the "Open in ChatGPT" button, which sends the page content to ChatGPT for further exploration and Q&A. Set to `false` to hide it.
806+ 控制 "Open in ChatGPT"按钮,该按钮会将页面内容发送给 ChatGPT 以便进一步探索和问答。设为 `false` 可隐藏该按钮。
807807</ParamField>
808808
809809<ParamField path="page-actions.options.claude" type="boolean" required={false} default="true" toc={true}>
810- Controls the "Open in Claude" button, which sends the page content to Claude for further exploration and Q&A. Set to `false` to hide it.
810+ 控制 "Open in Claude"按钮,该按钮会将页面内容发送给 Claude 以便进一步探索和问答。设为 `false` 可隐藏该按钮。
811811</ParamField>
812812
813813<ParamField path="page-actions.options.claude-code" type="boolean" required={false} default="true" toc={true}>
814- Controls the "Connect to Claude Code" button, which copies a `claude mcp add` command to the clipboard so users can register the docs site's [MCP server ](/learn/docs/ai-features/mcp-server) with Claude Code. Displays by default when [Ask Fern](/learn/docs/ai-features/ask-fern/overview) is enabled. Set to `false` to hide it.
814+ 控制 "Connect to Claude Code"按钮,该按钮会将 `claude mcp add` 命令复制到剪贴板,便于用户在 Claude Code 中注册文档站点的 [MCP 服务器 ](/learn/docs/ai-features/mcp-server)。当启用 [Ask Fern](/learn/docs/ai-features/ask-fern/overview) 时默认显示。设为 `false` 可隐藏该按钮。
815815</ParamField>
816816
817817<ParamField path="page-actions.options.cursor" type="boolean" required={false} default="true" toc={true}>
818- Controls the "Connect to Cursor" button, which installs the docs site's [MCP server ](/learn/docs/ai-features/mcp-server) in Cursor via a deeplink. Displays by default when [Ask Fern](/learn/docs/ai-features/ask-fern/overview) is enabled. Set to `false` to hide it.
818+ 控制 "Connect to Cursor"按钮,该按钮通过 deeplink 在 Cursor 中安装文档站点的 [MCP 服务器 ](/learn/docs/ai-features/mcp-server)。当启用 [Ask Fern](/learn/docs/ai-features/ask-fern/overview) 时默认显示。设为 `false` 可隐藏该按钮。
819819</ParamField>
820820
821821<ParamField path="page-actions.options.vscode" type="boolean" required={false} default="false" toc={true}>
822- When enabled, displays an "Open in VS Code" button that allows users to open the page content in Visual Studio Code for editing and development. Requires [Ask Fern](/learn/docs/ai-features/ask-fern/overview) to be enabled.
822+ 启用时会显示一个 "Open in VS Code"按钮,允许用户在 Visual Studio Code 中打开页面内容进行编辑和开发。需启用 [Ask Fern](/learn/docs/ai-features/ask-fern/overview)。
823823</ParamField>
824824
825825# ## 自定义页面操作
@@ -842,42 +842,42 @@ page-actions:
842842` ` `
843843
844844<ParamField path="page-actions.options.custom" type="list of objects" required={false} toc={true}>
845- An array of custom page action configurations. Each custom action appears as a button in the page actions menu.
845+ 自定义页面操作配置数组。每个自定义操作会作为按钮显示在页面操作菜单中。
846846</ParamField>
847847
848848<ParamField path="page-actions.options.custom[].title" type="string" required={true} toc={true}>
849- The title displayed for the custom action button.
849+ 自定义操作按钮显示的标题。
850850</ParamField>
851851
852852<ParamField path="page-actions.options.custom[].subtitle" type="string" required={false} toc={true}>
853- Optional helper text displayed below the title in the action menu.
853+ 可选的辅助说明文本,显示在操作菜单中标题下方。
854854</ParamField>
855855
856856<ParamField path="page-actions.options.custom[].url" type="string" required={true} toc={true}>
857- The URL to navigate to when the action is clicked. Supports the following placeholders :
858- - `{slug}` : The current page's slug (e.g., `getting-started/quickstart`)
859- - `{domain}` : The current domain (e.g., `docs.example.com`)
860- - `{url}` : The full URL of the current page (e.g., `https://docs.example.com/getting-started/quickstart`)
857+ 点击该操作时跳转的 URL。支持以下占位符:
858+ - ` {slug}` :当前页面的 slug(例如 `getting-started/quickstart`)
859+ - ` {domain}` :当前域名(例如 `docs.example.com`)
860+ - ` {url}` :当前页面的完整 URL(例如 `https://docs.example.com/getting-started/quickstart`)
861861</ParamField>
862862
863863<ParamField path="page-actions.options.custom[].icon" type="string" required={false} toc={true}>
864- Icon to display for the custom action.
864+ 自定义操作显示的图标。
865865
866866 <Markdown src="/products/docs/snippets/icons.mdx" />
867867</ParamField>
868868
869869<ParamField path="page-actions.options.custom[].default" type="boolean" required={false} default="false" toc={true}>
870- When set to `true`, this custom action becomes the default action displayed prominently in the page actions area.
871-
872- If you set `default : true` on a custom action, don't also set [`page-actions.default`](/learn/docs/configuration/site-level-settings#page-actionsdefault) to avoid conflicts.
870+ 设为 `true` 时,此自定义操作将成为在页面操作区域突出显示的默认操作。
871+
872+ 如果您在某个自定义操作上设置了 `default : true`,请不要同时设置 [`page-actions.default`](/learn/docs/configuration/site-level-settings#page-actionsdefault),以免冲突。
873873</ParamField>
874874
875875# # "编辑此页面" 配置
876876
877877在每个文档页面底部添加"编辑此页面"链接,方便读者提出修改建议。可在 `docs.yml` 文件中按 instance 进行配置。
878878
879879<Tabs>
880- <Tab title="Single Instance">
880+ <Tab title="单个 Instance">
881881` ` ` yaml
882882instances:
883883 - url: plantstore.docs.buildwithfern.com
@@ -890,9 +890,9 @@ instances:
890890` ` `
891891</Tab>
892892
893- <Tab title="Multiple Instances">
893+ <Tab title="多个 Instances">
894894` ` ` yaml
895- # Configure edit-this-page per instance
895+ # 按 instance 配置 edit-this-page
896896instances:
897897 - url: plantstore.docs.buildwithfern.com
898898 custom-domain: docs.plantstore.com
@@ -914,23 +914,23 @@ instances:
914914</Tabs>
915915
916916<Warning>
917- When using `launch : github`, the GitHub repository must be **public ** for the "Edit this page" link to work correctly. With `launch: dashboard`, users with editor access can edit via Fern Editor regardless of repository visibility.
917+ 使用 `launch : github` 时, GitHub 仓库必须是 **公开 ** 的,"编辑此页面"链接才能正常工作。使用 `launch: dashboard` 时,无论仓库的可见性如何,具有编辑器访问权限的用户都可以通过 Fern Editor 进行编辑。
918918</Warning>
919919
920920<ParamField path="github.owner" type="string" required={true} toc={true}>
921- The GitHub organization that owns the documentation repository.
921+ 拥有该文档仓库的 GitHub 组织。
922922</ParamField>
923923
924924<ParamField path="github.repo" type="string" required={true} toc={true}>
925- The name of the GitHub repository containing your fern folder.
925+ 包含您 fern 文件夹的 GitHub 仓库名称。
926926</ParamField>
927927
928928<ParamField path="github.branch" type="string" required={true} toc={true}>
929- The branch of the repository you would like the GitHub editor to open a PR to. Default is `main`.
929+ 您希望 GitHub 编辑器提交 PR 到的仓库分支。默认为 `main`。
930930</ParamField>
931931
932932<ParamField path="launch" type="'github' | 'dashboard'" required={false} default="github" toc={true}>
933- Controls the behavior of the ["Edit this page" button ](/learn/docs/user-feedback#edit-this-page). When set to `dashboard`, clicking the button opens a screen where users can choose between starting a [Fern Editor](/learn/docs/writing-content/fern-editor) session for that page or going straight to the source in GitHub (best for internal sites). Defaults to `github`, which links directly to the file on GitHub (best for public-facing sites).
933+ 控制 ["编辑此页面"按钮 ](/learn/docs/user-feedback#edit-this-page) 的行为。设为 `dashboard` 时,点击按钮会打开一个界面,用户可以选择为该页面启动 [Fern Editor](/learn/docs/writing-content/fern-editor) 会话,或直接跳转到 GitHub 上的源文件(最适合内部站点)。默认为 `github`,即直接链接到 GitHub 上的文件(最适合面向公众的站点)。
934934</ParamField>
935935
936936# # 落地页配置
@@ -945,25 +945,25 @@ landing-page:
945945` ` `
946946
947947<ParamField path="page" type="string" required={true} toc={true}>
948- The name of the landing page.
948+ 落地页的名称。
949949</ParamField>
950950
951951<ParamField path="path" type="string" required={true}>
952- Relative filepath to the desired landing page Markdown file. The path is relative to the YAML file where it is set (e.g., `docs.yml`).
952+ 目标落地页 Markdown 文件的相对路径。路径相对于设置该字段的 YAML 文件(例如 `docs.yml`)。
953953</ParamField>
954954
955955<ParamField path="slug" type="string" required={false} toc={true}>
956- The slug of the landing page. Defaults to the page name.
957-
958- The slug can also be overridden in the frontmatter of the landing page Markdown file.
956+ 落地页的 slug。默认使用页面名称。
957+
958+ 也可以在落地页 Markdown 文件的 frontmatter 中覆盖该 slug。
959959</ParamField>
960960
961961# # SEO 元数据配置
962962
963963配置站点范围的 Open Graph 和 Twitter Card 元数据,控制您的文档在社交媒体预览和搜索结果中的呈现方式。
964964
965- <Note title="Looking to set metadata for a single page? ">
966- [Use the `keywords` property in a page's frontmatter ](/docs/configuration/page-level-settings#seo-metadata).
965+ <Note title="需要为单个页面设置元数据? ">
966+ [请在该页面的 frontmatter 中使用 `keywords` 属性 ](/docs/configuration/page-level-settings#seo-metadata)。
967967</Note>
968968
969969
@@ -996,75 +996,75 @@ metadata:
996996` ` `
997997
998998<ParamField path="metadata.og:site_name" type="string" required={false}>
999- The name of your website for Open Graph tags.
999+ Open Graph 标签中显示的网站名称。
10001000</ParamField>
10011001
10021002<ParamField path="metadata.og:title" type="string" required={false}>
1003- The title shown in social media previews.
1003+ 社交媒体预览中显示的标题。
10041004</ParamField>
10051005
10061006<ParamField path="metadata.og:description" type="string" required={false}>
1007- The description shown in social media previews.
1007+ 社交媒体预览中显示的描述。
10081008</ParamField>
10091009
10101010<ParamField path="metadata.og:url" type="string" required={false}>
1011- The canonical URL of your documentation.
1011+ 您文档的规范 URL。
10121012</ParamField>
10131013
10141014<ParamField path="metadata.og:image" type="string" required={false}>
1015- The image shown in social media previews. Recommended size is 1200x630 pixels.
1015+ 社交媒体预览中显示的图片。推荐尺寸为 1200x630 像素。
10161016</ParamField>
10171017
10181018<ParamField path="metadata.og:image:width" type="number" required={false}>
1019- The width of your Open Graph image in pixels.
1019+ Open Graph 图片的宽度(像素)。
10201020</ParamField>
10211021
10221022<ParamField path="metadata.og:image:height" type="number" required={false}>
1023- The height of your Open Graph image in pixels.
1023+ Open Graph 图片的高度(像素)。
10241024</ParamField>
10251025
10261026<ParamField path="metadata.og:locale" type="string" required={false}>
1027- The locale of your content (e.g., "en_US").
1027+ 您内容的 locale(例如 "en_US")。
10281028</ParamField>
10291029
10301030<ParamField path="metadata.og:logo" type="string" required={false}>
1031- URL to your company logo.
1031+ 您公司 Logo 的 URL。
10321032</ParamField>
10331033
10341034<ParamField path="metadata.twitter:title" type="string" required={false}>
1035- The title shown in Twitter Card previews.
1035+ Twitter Card 预览中显示的标题。
10361036</ParamField>
10371037
10381038<ParamField path="metadata.twitter:description" type="string" required={false}>
1039- The description shown in Twitter Card previews.
1039+ Twitter Card 预览中显示的描述。
10401040</ParamField>
10411041
10421042<ParamField path="metadata.twitter:handle" type="string" required={false}>
1043- Your company's Twitter handle.
1043+ 您公司的 Twitter 用户名。
10441044</ParamField>
10451045
10461046<ParamField path="metadata.twitter:image" type="string" required={false}>
1047- The image shown in Twitter Card previews.
1047+ Twitter Card 预览中显示的图片。
10481048</ParamField>
10491049
10501050<ParamField path="metadata.twitter:site" type="string" required={false}>
1051- The Twitter handle for your website.
1051+ 您网站的 Twitter 用户名。
10521052</ParamField>
10531053
10541054<ParamField path="metadata.twitter:card" type="string" required={false}>
1055- The Twitter Card type. Options are `summary`, `summary_large_image`, `app`, or `player`.
1055+ Twitter Card 类型。可选值: `summary`、 `summary_large_image`、 `app` 或 `player`。
10561056</ParamField>
10571057
10581058<ParamField path="metadata.og:dynamic" type="boolean" required={false}>
1059- When `true`, enables dynamic OG image generation for pages that don't have a custom `og:image` set.
1059+ 设为 `true` 时,对未设置自定义 `og:image` 的页面启用动态 OG 图像生成。
10601060</ParamField>
10611061
10621062<ParamField path="metadata.og:background-image" type="string" required={false}>
1063- A custom background image for dynamically generated OG images. Can be a URL or a relative file path. Relative paths are resolved from the YAML file where this property is set (e.g., `docs.yml`).
1063+ 动态生成的 OG 图像所使用的自定义背景图。可以是 URL 或相对文件路径。相对路径相对于设置该字段的 YAML 文件(例如 `docs.yml`)解析。
10641064</ParamField>
10651065
10661066<ParamField path="metadata.canonical-host" type="string" required={false}>
1067- The host of your documentation website. This will be used to set the canonical URL for metadata tags and documents like the sitemap.
1067+ 您文档站点的主机名。将用于设置元数据标签和站点地图等文档的规范 URL。
10681068
10691069 Defaults to the URL defined in the `instances` configuration.
10701070</ParamField>
0 commit comments