marmotte / vitepress/sidebar

vitepress/sidebar

Functions

default()

default(options?): object

Defined in: src/vitepress/sidebar.ts:21

Parameters

options?

SidebarOptions | SidebarOptions[]

Returns

object

enforce

enforce: "post" = "post"

name

name: string = "marmotte:vitepress-sidebar"

config()

config(this, cfg): void

Parameters

this

ConfigPluginContext

cfg

UserConfig

Returns

void

configureServer()

configureServer(this, server): void

Parameters

this

MinimalPluginContextWithoutEnvironment

server

ViteDevServer

Returns

void

---

generateSidebar()

generateSidebar(options?): Sidebar

Defined in: node_modules/vitepress-sidebar/dist/sidebar.d.ts:3

Parameters

options?

VitePressSidebarOptions | VitePressSidebarOptions[]

Returns

Sidebar

---

withSidebar()

withSidebar(vitePressOptions, sidebarOptions?): Partial<UserConfig>

Defined in: node_modules/vitepress-sidebar/dist/sidebar.d.ts:4

Parameters

vitePressOptions

UserConfig

sidebarOptions?

VitePressSidebarOptions | VitePressSidebarOptions[]

Returns

Partial<UserConfig>