Skip to content

Commit

Permalink
doc: update config and add search
Browse files Browse the repository at this point in the history
  • Loading branch information
dwightjack committed Dec 10, 2024
1 parent 5225c67 commit f1b8fca
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 4 deletions.
3 changes: 3 additions & 0 deletions packages/docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,9 @@ export default defineConfig({
},
},
themeConfig: {
search: {
provider: 'local',
},
siteTitle: 'VueTypes v' + version,
editLink: {
pattern:
Expand Down
11 changes: 7 additions & 4 deletions packages/docs/guide/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,23 +7,26 @@ Starting from version 4, VueTypes has a global configuration object that can be

The configuration is exposed both as a property of the default export, and as a named export:

::: code-group
::: tabs

```ts [named export]
== Named export

```js
import { config } from 'vue-types'

VueTypes.config === config
```

```js [default export]
== Default export

```js{sss.js}
import VueTypes from 'vue-types'
VueTypes.config === config
```

:::


## Configuration Options

- `silent`: (boolean, default `false`) set to `true` to prevent VueTypes from logging validation warnings.
Expand Down

0 comments on commit f1b8fca

Please sign in to comment.