Skip to content

Commit

Permalink
Flip the default to show the logo by default
Browse files Browse the repository at this point in the history
  • Loading branch information
chalin committed Aug 18, 2022
1 parent 26811b8 commit b6b2dc4
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 4 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,14 @@ For a full list of the changes to this release, see the [release notes][0.5.0].
- [Upgrade FontAwesome to v6](https://fontawesome.com/docs/web/setup/upgrade/) from v5. Lots of icons got renamed, but the v5 names will still work.

Please review the [Backward compatibility](https://fontawesome.com/docs/web/setup/upgrade/whats-changed#backward-compatibility) information for the complete details.
- Most projects show their logo in the navbar. In support of this majority,
Docsy now displays a logo by default. For details on how to hide the logo (or
your brand name), see [Styling your brand logo and name][].

[docsy as an npm package]:
https://www.docsy.dev/docs/get-started/other-options/#option-3-docsy-as-an-npm-package
[styling your brand logo and name]:
/docs/adding-content/lookandfeel/#styling-your-brand-logo-and-name

## [0.4.0][]

Expand Down
2 changes: 1 addition & 1 deletion layouts/partials/navbar.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<a class="navbar-brand" href="{{ .Site.Home.RelPermalink }}">
{{- /**/ -}}
<span class="navbar-brand__logo navbar-logo">
{{- if .Site.Params.ui.navbar_logo -}}
{{- if ne .Site.Params.ui.navbar_logo false -}}
{{ with resources.Get "icons/logo.svg" -}}
{{ ( . | minify).Content | safeHTML -}}
{{ end -}}
Expand Down
1 change: 0 additions & 1 deletion userguide/config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,6 @@ params:
sidebar_cache_limit: 10
breadcrumb_disable: false
sidebar_search_disable: false
navbar_logo: true
feedback:
enable: true
'yes': >-
Expand Down
7 changes: 5 additions & 2 deletions userguide/content/en/docs/adding-content/iconsimages.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,11 @@ description: Add and customize logos, icons, and images in your project.

## Add your logo

Place your project logo in `assets/icons/logo.svg`. This overrides the default
Docsy logo in the theme. If you don't want a project logo, set `navbar_logo` to
By default, Docsy shows a site logo at the start of the navbar, that is, at the
extreme left. Place your project's SVG logo in `assets/icons/logo.svg`. This
overrides the default Docsy logo in the theme.

If you don't want a logo to appear in the navbar, then set `navbar_logo` to
`false` in your project's config:

{{< tabpane persistLang=false >}}
Expand Down

0 comments on commit b6b2dc4

Please sign in to comment.