Skip to content

Feat: meta-tags are now configurable #254

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: release
Choose a base branch
from
Open

Feat: meta-tags are now configurable #254

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion config.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,13 @@
min = "0.140.0"
[[module.imports]]
path = "github.com/gohugoio/hugo-mod-bootstrap-scss/v5"
disable = false
disable = false

[params]
[params.head]
author = "Colin Wilson - Lotus Labs"
description = "A Lightweight, Modern Documentation Theme for Hugo"
keywords = "Documentation, Hugo, Hugo Theme, Bootstrap"
email = "[email protected]"
website = "https://lotusdocs.dev"
version = "v0.1.0"
8 changes: 8 additions & 0 deletions exampleSite/hugo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,14 @@ defaultContentLanguage = 'en'
secondary_font = "Inter" # Default is System font
mono_font = "Fira Code" # Default is System font

[params.head] # Use these to override the default meta-tags in the page headers
# author = "Colin Wilson - Lotus Labs"
# description = "A Lightweight, Modern Documentation Theme for Hugo"
# keywords = "Documentation, Hugo, Hugo Theme, Bootstrap"
# email = "[email protected]"
# website = "https://lotusdocs.dev"
# version = "v0.1.0"

[params.footer]
copyright = "© :YEAR: Lotus Labs. Built with [**Lotus Docs**](https://github.com/colinwilson/lotusdocs)"
# version = true # includes git commit info
Expand Down
23 changes: 17 additions & 6 deletions layouts/partials/docs/head.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,25 @@
<meta name="robots" content="noindex">
{{- end }}
<meta name="viewport" content="width=device-width, initial-scale=1.0">
{{- with .Description | default ($.Param "description") }}

{{- with .Description | default (.Site.Params.head.description) }}
<meta name="description" content="{{ . }}">
{{- end }}
<meta name="keywords" content="Documentation, Hugo, Hugo Theme, Bootstrap" />
<meta name="author" content="Colin Wilson - Lotus Labs" />
<meta name="email" content="[email protected]" />
<meta name="website" content="https://lotusdocs.dev" />
<meta name="Version" content="v0.1.0" />
{{- with .Params.keywords | default (.Site.Params.head.keywords)}}
<meta name="keywords" content="{{.}}" />
{{- end }}
{{- with .Params.author | default (.Site.Params.head.author)}}
<meta name="author" content="{{.}}" />
{{- end }}
{{- with .Params.email | default (.Site.Params.head.email)}}
<meta name="email" content="{{.}}" />
{{- end }}
{{- with .Params.website | default (.Site.Params.head.website)}}
<meta name="website" content="{{.}}" />
{{- end }}
{{- with .Params.version | default (.Site.Params.head.version)}}
<meta name="Version" content="{{.}}" />
{{- end }}
<!-- favicon -->
{{ block "favicon" . }}{{ partialCached (printf "%s/%s" ($.Scratch.Get "pathName") "head/favicon.html") . }}{{ end }}
{{- partial (printf "%s/%s" ($.Scratch.Get "pathName") "head/opengraph") . }}
Expand Down
12 changes: 6 additions & 6 deletions layouts/partials/head.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@
<meta name="robots" content="noindex">
{{- end }}
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="A Lightweight, Modern Documentation Theme for Hugo" />
<meta name="keywords" content="Documentation, Hugo, Hugo Theme, Bootstrap" />
<meta name="author" content="Colin Wilson - Lotus Labs" />
<meta name="email" content="[email protected]" />
<meta name="website" content="https://lotusdocs.dev" />
<meta name="Version" content="v0.1.0" />
<meta name="description" content="{{ .Site.Params.head.description }}" />
<meta name="keywords" content="{{ .Site.Params.head.keywords}}" />
<meta name="author" content="{{ .Site.Params.head.author }}" />
<meta name="email" content="{{ .Site.Params.head.email}}" />
<meta name="website" content="{{ .Site.Params.head.website}}" />
<meta name="Version" content="{{ .Site.Params.head.version}}" />
<!-- favicon -->
{{ block "head/favicon" . }}{{ partialCached "head/favicon.html" . }}{{ end }}
<!-- Google Fonts -->
Expand Down
Loading