Skip to content

Commit

Permalink
docs: add different logos for light and dark modes (#1155)
Browse files Browse the repository at this point in the history
Co-authored-by: Divyansh Singh <[email protected]>
  • Loading branch information
rijkvanzanten and brc-dd authored Aug 10, 2022
1 parent e8cb73e commit 8f80bd0
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions docs/config/theme-configs.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ Here it describes the settings for the VitePress default theme. If you're using

## logo

- Type: `string`
- Type: `ThemeableImage`

Logo file to display in nav bar, right before the site title.
Logo file to display in nav bar, right before the site title. Accepts a path string, or an object to set a different logo for light/dark mode.

```ts
export default {
Expand All @@ -33,6 +33,11 @@ export default {
}
```

```ts
type Image = string | { src: string; alt?: string }
type ThemeableImage = Image | { light: Image; dark: Image }
```
## siteTitle
- Type: `string | false`
Expand Down

0 comments on commit 8f80bd0

Please sign in to comment.