mirror of
https://github.com/pengzhanbo/vuepress-theme-plume.git
synced 2026-04-26 11:38:15 +08:00
45 lines
1.1 KiB
Markdown
45 lines
1.1 KiB
Markdown
---
|
|
url: /en/guide/api/node/index.md
|
|
---
|
|
## Usage
|
|
|
|
```ts
|
|
import { plumeTheme } from 'vuepress-theme-plume'
|
|
```
|
|
|
|
## `plumeTheme(options)`
|
|
|
|
**options** : `PlumeThemeOptions`
|
|
|
|
Theme configuration function.
|
|
|
|
See [Theme Configuration](../config/theme.md) for more information.
|
|
|
|
## `defineThemeConfig(options)`
|
|
|
|
Theme configuration helper function for use in separate `plume.config.ts` files.
|
|
|
|
See [Theme Configuration File](../config/intro.md#theme-configuration-file) for more information.
|
|
|
|
## `defineNavbarConfig(options)`
|
|
|
|
Theme navbar configuration type helper function.
|
|
|
|
See [Theme Configuration](../config/navbar.md) for more information.
|
|
|
|
## `defineCollections(options)`
|
|
|
|
**options:** `(ThemePostCollection | ThemeDocCollection)[]`
|
|
|
|
Theme collections configuration type helper function.
|
|
|
|
See [Theme Configuration](../config/collection.md) for more information.
|
|
|
|
## `defineCollection(options)`
|
|
|
|
**options:** `ThemePostCollection | ThemeDocCollection`
|
|
|
|
Theme single collection configuration type helper function.
|
|
|
|
See [Theme Configuration](../config/collection.md) for more information.
|