Skip to content

Commit

Permalink
docs: update default-theme sidebar type (#3715)
Browse files Browse the repository at this point in the history
  • Loading branch information
李小控 committed Apr 7, 2024
1 parent 54c46e7 commit c4ae9d3
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion docs/reference/default-theme-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ export default {
export type Sidebar = SidebarItem[] | SidebarMulti

export interface SidebarMulti {
[path: string]: SidebarItem[]
[path: string]: SidebarItem[] | { items: SidebarItem[]; base: string }
}

export type SidebarItem = {
Expand All @@ -162,6 +162,19 @@ export type SidebarItem = {
* If `false`, group is collapsible but expanded by default
*/
collapsed?: boolean

/**
* Base path for the children items.
*/
base?: string

/**
* Customize text that appears on the footer of previous/next page.
*/
docFooterText?: string

rel?: string
target?: string
}
```
Expand Down

0 comments on commit c4ae9d3

Please sign in to comment.