From 085c2b8d65f073d276167f872f08a5c34a73cd69 Mon Sep 17 00:00:00 2001 From: liruifengv Date: Thu, 4 Jan 2024 13:05:31 +0800 Subject: [PATCH 1/3] i18n(zh-cn): Update overrides.md --- docs/src/content/docs/zh-cn/reference/overrides.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/src/content/docs/zh-cn/reference/overrides.md b/docs/src/content/docs/zh-cn/reference/overrides.md index 1ebad0f3c30..95f35faced1 100644 --- a/docs/src/content/docs/zh-cn/reference/overrides.md +++ b/docs/src/content/docs/zh-cn/reference/overrides.md @@ -18,6 +18,7 @@ tableOfContents: ```astro --- +// src/components/Custom.astro import type { Props } from '@astrojs/starlight/props'; const { hasSidebar } = Astro.props; @@ -134,6 +135,12 @@ entry: { 如果启用了，表示可以编辑此页面的地址的 JavaScript `URL` 对象。 +#### `labels` + +**类型：** `Record` + +一个包含为当前页面本地化的 UI 字符串的对象。请参阅[“翻译 Starlight 的 UI”](/zh-cn/guides/i18n/#translate-starlights-ui)指南以获取所有可用键的列表。 + --- ## 组件 @@ -227,6 +234,10 @@ entry: { 用于渲染 Starlight 搜索 UI 的组件。 默认实现包含在导航栏中的按钮和在点击时显示搜索模态框以及加载 [Pagefind UI](https://pagefind.app/) 的代码。 +当 [`pagefind`](/zh-cn/reference/configuration/#pagefind) 被禁用时，默认的搜索组件不会被渲染。 +然而，如果你重写了 `Search`，你的自定义组件将总是被渲染，即使 `pagefind` 配置选项是 `false`。 +这允许你在禁用 Pagefind 时为其他搜索提供商添加 UI。 + #### `SocialIcons` **默认组件：** [`SocialIcons.astro`](https://github.com/withastro/starlight/blob/main/packages/starlight/components/SocialIcons.astro) @@ -342,6 +353,7 @@ Starlight 的页面侧边栏负责显示当前页面的子标题的目录。 在页面主内容列中渲染 Markdown 内容的组件。 默认实现为 Markdown 内容提供了基本的样式。 +Markdown 内容样式也暴露在 `@astrojs/starlight/style/markdown.css` 中，并且作用域限制在 `.sl-markdown-content` CSS 类中。 --- ### 页脚 From 076cf2638bf5a8ac7d8a2f492ce2a0e556009b5f Mon Sep 17 00:00:00 2001 From: liruifengv Date: Thu, 4 Jan 2024 13:08:55 +0800 Subject: [PATCH 2/3] Update UI localization link in overrides.md --- docs/src/content/docs/zh-cn/reference/overrides.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/content/docs/zh-cn/reference/overrides.md b/docs/src/content/docs/zh-cn/reference/overrides.md index 95f35faced1..cef3ef85d4a 100644 --- a/docs/src/content/docs/zh-cn/reference/overrides.md +++ b/docs/src/content/docs/zh-cn/reference/overrides.md @@ -139,7 +139,7 @@ entry: { **类型：** `Record` -一个包含为当前页面本地化的 UI 字符串的对象。请参阅[“翻译 Starlight 的 UI”](/zh-cn/guides/i18n/#translate-starlights-ui)指南以获取所有可用键的列表。 +一个包含为当前页面本地化的 UI 字符串的对象。请参阅[“翻译 Starlight 的 UI”](/zh-cn/guides/i18n/#翻译-starlight-的-ui)指南以获取所有可用键的列表。 --- From c4cbdd5d06b02749fb717d957bea36ff2c185109 Mon Sep 17 00:00:00 2001 From: liruifengv Date: Thu, 4 Jan 2024 13:12:18 +0800 Subject: [PATCH 3/3] Update UI localization strings and markdown content style --- docs/src/content/docs/zh-cn/reference/overrides.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/src/content/docs/zh-cn/reference/overrides.md b/docs/src/content/docs/zh-cn/reference/overrides.md index cef3ef85d4a..95e37e4d327 100644 --- a/docs/src/content/docs/zh-cn/reference/overrides.md +++ b/docs/src/content/docs/zh-cn/reference/overrides.md @@ -139,7 +139,7 @@ entry: { **类型：** `Record` -一个包含为当前页面本地化的 UI 字符串的对象。请参阅[“翻译 Starlight 的 UI”](/zh-cn/guides/i18n/#翻译-starlight-的-ui)指南以获取所有可用键的列表。 +一个包含为当前页面本地化的 UI 字符串的对象。请参阅 [“翻译 Starlight UI”](/zh-cn/guides/i18n/#翻译-starlight-的-ui) 指南以获取所有可用键的列表。 --- @@ -354,6 +354,7 @@ Starlight 的页面侧边栏负责显示当前页面的子标题的目录。 默认实现为 Markdown 内容提供了基本的样式。 Markdown 内容样式也暴露在 `@astrojs/starlight/style/markdown.css` 中，并且作用域限制在 `.sl-markdown-content` CSS 类中。 + --- ### 页脚