Skip to content

Commit

Permalink
Merge pull request #168 from flowershow/navbar-theme-docs
Browse files Browse the repository at this point in the history
[Content]: Add docs for navbar title, logo and disabling theme
  • Loading branch information
khalilcodes authored Sep 14, 2022
2 parents 73f9b57 + 687a132 commit ba0734f
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 0 deletions.
18 changes: 18 additions & 0 deletions site/content/docs/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,21 @@ const userConfig = {

export default userConfig
```

## Navbar Title and Logo

The Title and Logo in the navbar can be set by adding a **navbarTitle** attribute in your config. If you don't want a logo to be displayed in the navbar of your site, then don't include the logo field.

The **navbarTitle** supports adding the following two fields:

* text (your navbar title)
* logo (path to your logo img file)

```js
const userConfig = {
navBarTitle: {
text: 'Your custom title here',
logo: '/assets/your-logo.svg'
}
}
```
14 changes: 14 additions & 0 deletions site/content/docs/theme.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,20 @@ const config = {
```
Note that in dark mode the color of the icon is set to grayscale and once toggled to light mode it would then render it's original color.

### Disabling the Dark/Light theme

To disable any theme options and not have a theme toggle, set the theme.default option to a blank string value as can be seen below. Doing this will force a light theme on the site.

```js
// config.js

const config = {
theme: {
default: ''
}
}
```

### Dark theme

![[dark-theme.jpg]]
Expand Down
7 changes: 7 additions & 0 deletions templates/default/.changeset/thick-jars-fetch.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
'default': minor
---

Update documentation for:
- how to set Navbar title and logo
- how to disable dark/light theme modes

0 comments on commit ba0734f

Please sign in to comment.