From 9f063426e2c7e717961b957825f56a2f792c7a29 Mon Sep 17 00:00:00 2001 From: manchan <2445937718@qq.com> Date: Wed, 1 Feb 2023 16:53:05 +0800 Subject: [PATCH] docs: update theme configs (#1877) --- docs/config/theme-configs.md | 42 ++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) diff --git a/docs/config/theme-configs.md b/docs/config/theme-configs.md index b618af1a..d72d7d1b 100644 --- a/docs/config/theme-configs.md +++ b/docs/config/theme-configs.md @@ -164,6 +164,13 @@ export type SidebarItem = { The levels of header to display in the outline. You can specify a particular level by passing a number, or you can provide a level range by passing a tuple containing the bottom and upper limits. When passing `'deep'` which equals `[2, 6]`, all header levels are shown in the outline except `h1`. Set `false` to hide outline. +## outlineBadges + +- Type: `boolean` +- Default: `true` + +By default the badge text is displayed in the outline. Disable this to hide badge text from outline. + ## outlineTitle - Type: `string` @@ -285,6 +292,20 @@ export default { } ``` +## algolia + +- Type: `AlgoliaSearch` + +An option to support searching your docs site using [Algolia DocSearch](https://docsearch.algolia.com/docs/what-is-docsearch). Learn more in [Theme: Search](../guide/theme-search) + +```ts +export interface AlgoliaSearchOptions extends DocSearchProps { + locales?: Record> +} +``` + +View full options [here](https://github.com/vuejs/vitepress/blob/main/types/docsearch.d.ts). + ## carbonAds {#carbon-ads} - Type: `CarbonAds` @@ -334,3 +355,24 @@ export interface DocFooter { next?: string } ``` + +## darkModeSwitchLabel + +- Type: `string` +- Default: `Appearance` + +Can be used to customize the dark mode switch label. This label is only displayed in the mobile view. + +## sidebarMenuLabel + +- Type: `string` +- Default: `Menu` + +Can be used to customize the sidebar menu label. This label is only displayed in the mobile view. + +## returnToTopLabel + +- Type: `string` +- Default: `Return to top` + +Can be used to customize the label of the returnToTop. This label is only displayed in the mobile view. \ No newline at end of file