Skip to content

Commit

Permalink
feat(theme): improve locales (#366)
Browse files Browse the repository at this point in the history
* chore: tweak

* feat(theme): improve locales
  • Loading branch information
pengzhanbo authored Nov 29, 2024
1 parent 8b39248 commit 9906f1a
Show file tree
Hide file tree
Showing 21 changed files with 418 additions and 380 deletions.
2 changes: 1 addition & 1 deletion docs/.vuepress/notes/zh/theme-config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ export const themeConfig = defineNoteConfig({
collapsed: false,
items: [
'配置说明',
'多语言配置',
'主题配置',
'多语言配置',
'导航栏配置',
'notes配置',
'侧边栏配置',
Expand Down
168 changes: 2 additions & 166 deletions docs/notes/theme/config/主题配置.md
Original file line number Diff line number Diff line change
Expand Up @@ -344,9 +344,9 @@ interface LastUpdatedOptions {
- 默认值: `{}`
- 详情: 多语言配置

多语言配置,参考 [此文档](./多语言配置.md)
不同语言的文本配置,参考 [此文档](./多语言配置.md)

多语言配置支持以下 [Locale](#locale-配置) 所有配置选项
多语言配置支持以下 [Locale](#locale-配置) 所有配置选项以控制不同语言下的主题行为。

## Locale 配置

Expand Down Expand Up @@ -385,16 +385,6 @@ interface LastUpdatedOptions {

此选项注入一个内联脚本,从本地存储恢复用户设置。这确保在呈现页面之前应用 `[data-theme="dark"]` 以避免闪烁。

### appearanceText

- 类型: `string`
- 默认值: `'Appearance'`
- 详情: 导航栏中的主题切换按钮的文本。

### avatar <Badge type="danger" text="弃用" />

弃用,请使用 [profile](#profile)

### profile

- 类型: `ProfileOptions`
Expand Down Expand Up @@ -740,66 +730,6 @@ interface SidebarItem {

详情请参考 [公告板](../guide/功能/公告板.md)

### selectLanguageName

- 类型: `string`
- 默认值: `''`
- 详情:

Locale 的语言名称。

该配置项 **仅能在主题配置的 [locales](#locales) 的内部生效** 。它将被用作 locale 的语言名称,展示在 _选择语言菜单_ 内。

### selectLanguageText

- 类型: `string`
- 默认值: `''`
- 详情:

_选择语言菜单_ 的文本。

如果你在站点配置中设置了多个 [locales](#locales) ,那么 _选择语言菜单_ 就会显示在导航栏中仓库按钮的旁边。

### selectLanguageAriaLabel

- 类型: `string`
- 默认值: `''`
- 详情:

_选择语言菜单 的 `aria-label` 属性。_

它主要是为了站点的可访问性 (a11y) 。

### sidebarMenuLabel

- 类型: `string`
- 默认值: `'Menu'`
- 详情:

移动设备下的导航栏中 菜单选项的文本。

### returnToTopLabel

- 类型: `string`
- 默认值: `'return to top'`
- 详情:

移动设备下的导航栏中返回顶部的文本。

### outlineLabel

- 类型: `string`
- 默认值: `'On this page'`
- 详情:

移动设备下的导航栏中大纲标题的文本

### editLinkText

- 类型: `string`
- 默认值: `'Edit this page'`
- 详情: 编辑链接文本

### editLinkPattern

- 类型: `string`
Expand All @@ -808,36 +738,6 @@ interface SidebarItem {

示例: `':repo/edit/:branch/:path'`

### latestUpdatedText

- 类型: `string`
- 默认值: `'Latest Updated'`
- 详情: 最近更新时间 的文本

### contributorsText

- 类型: `string`
- 默认值: `'Contributors'`
- 详情: 贡献者的文本

### changelogText

- 类型: `string`
- 默认值: `'Changelog'`
- 详情: 变更记录的文本

### changelogOnText

- 类型: `string`
- 默认值: `'On'`
- 详情: 单次变更记录的时间文本

### changelogButtonText

- 类型: `string`
- 默认值: `'View All Changelog'`
- 详情: 变更记录的按钮文本

### copyright

- 类型: `boolean | CopyrightLicense | CopyrightOptions`
Expand All @@ -846,66 +746,18 @@ interface SidebarItem {

详情请参考 [版权所有](../guide/功能/文章版权所有.md)

### copyrightText

- 类型: `string`
- 默认值: `'Copyright'`
- 详情: 版权所有的文本

### copyrightAuthorText

- 类型: `string`
- 默认值: `'Copyright Ownership:'`
- 详情: 版权所有者的文本

### copyrightCreationOriginalText

- 类型: `string`
- 默认值: `'This article link:'`
- 详情: 本文链接的文本

### copyrightCreationTranslateText

- 类型: `string`
- 默认值: `'This article translated from:'`
- 详情: 本文翻译的文本

### copyrightCreationReprintText

- 类型: `string`
- 默认值: `'This article reprint from:'`
- 详情: 本文转载的文本

### copyrightLicenseText

- 类型: `string`
- 默认值: `'License under:'`
- 详情: 版权许可证的文本

### prevPage

- 类型: `boolean`
- 默认值: `true`
- 详情: 是否显示上一页

### prevPageLabel

- 类型: `string`
- 默认值: `'Previous Page'`
- 详情: 上一页的文本

### nextPage

- 类型: `boolean`
- 默认值: `true`
- 详情: 是否显示下一页

### nextPageLabel

- 类型: `string`
- 默认值: `'Next Page'`
- 详情: 下一页的文本

### createTime

- 类型: `boolean | 'only-blog'`
Expand All @@ -915,19 +767,3 @@ interface SidebarItem {
- `false` - 不显示
- `'only-blog'` - 只显示在博客文章页面
- `true` - 显示在所有文章页面

### notFound

- 类型: `NotFound | undefined`
- 默认值: `undefined`
- 详情: 404 页面配置

```ts
interface NotFound {
code?: string
title?: string
quote?: string
linkLabel?: string
linkText?: string
}
```
Loading

0 comments on commit 9906f1a

Please sign in to comment.