Websites/Hugo-Shortcodes
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Add search engine optimization

Browse Source
This commit is contained in:
Kim Oliver Drechsel 2022-01-14 23:33:29 +01:00
parent 74192d5252
commit 46663891c3
Signed by: Kim
GPG Key ID: B9D907EF02605A07
4 changed files with 125 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -25,3 +25,15 @@ A Collection of useful Hugo Shortcodes
Add a automatically generated Table of Contents to any Page/Post on your Website
![Example Table of Contents in hugo](table_of_contents/table_of_contents.png)
- ## [Search Engine Optimization](search_engine_optimization)
Add automatically generated Search Engine Optimization to your Website
```html
<meta name="keywords" content="default-tag1, default-tag2, default-tag3" />
<meta name="robots" content="index, follow" />
<link rel="canonical" href="http://localhost:1313/posts/example-post" />
<link rel="alternate" href="http://localhost:1313/posts/example-post" hreflang="en-us" />
<link rel="alternate" type="application/rss+xml" href="http://localhost:1313/index.xml" title="Example Blog" />
```

99
search_engine_optimization/README.md Normal file
View File

@ -0,0 +1,99 @@
# Search Engine Optimization in Hugo
Add automatically generated Search Engine Optimization to your Website
## Install
1. Add this code to your `<head></head>` structure (e.g in `layouts/_default/baseof.html`):
```html
<!-- Site Indexing toggled by key value of `private` in Page/Post Settings -->
<meta name="robots" content=
{{- if or (.Params.private) (in (string .Permalink) "404.html") (in (string .Permalink) "404.php") -}}
"noindex, nofollow"
{{- else -}}
"index, follow"
{{ end }} />
<!-- Meta Keywords/Tags for Users to search for in Search Engines -->
<meta name="keywords" content="
{{- with .Params.tags }}
{{- range . -}}
{{ with $.Site.GetPage (printf "/%s/%s" "tags" . ) }}
{{- .Title -}},
{{- end }}
{{- end }}
{{- else -}}
Tutorials, Tips, Linux, Bash, Docker
{{- end }}" />
<!-- Canonical URLs -->
<link rel="canonical" href="{{ .Permalink }}" />
<link rel="alternate" href="{{ .Permalink }}" hreflang="{{ .Site.LanguageCode }}" />
<!-- Links to RSS Feed -->
{{ range .AlternativeOutputFormats -}}
{{ printf `<link rel="%s" type="%s" href="%s" title="%s" />` .Rel .MediaType.Type .Permalink $.Site.Title | safeHTML }}
{{ end -}}
```
2. Add the default key/value `private = true` to `/archetypes/default.md`
```yaml
---
title: "{{ replace .Name "-" " " | title }}"
date: {{ .Date }}
draft: true
## Add this key with value 'false' for indexing by search engines enabled by default
private: false
---
```
## Usage
Add these keys and values to any page's settings:
```toml
+++
...
tags = ["fruit", "apple", "health"] # Fitting keywords that describe your post/page
private = true # true if you want it private/unlisted
+++
```
## Preview
### Public
### Example Post
```html
<meta name="keywords" content="Tag1, Tag2, Tag3" />
<meta name="robots" content="index, follow" />
<link rel="canonical" href="http://localhost:1313/" />
<link rel="alternate" href="http://localhost:1313/" hreflang="en-us" />
<link rel="alternate" type="application/rss+xml" href="http://localhost:1313/index.xml" title="Example Blog" />
```
#### Index
```html
<meta name="keywords" content="default-tag1, default-tag2, default-tag3" />
<meta name="robots" content="index, follow" />
<link rel="canonical" href="http://localhost:1313/posts/example-post" />
<link rel="alternate" href="http://localhost:1313/posts/example-post" hreflang="en-us" />
<link rel="alternate" type="application/rss+xml" href="http://localhost:1313/index.xml" title="Example Blog" />
```
### Private
> 404 Page is private by default
```html
<meta name="keywords" content="Tag1, Tag2, Tag3" />
<meta name="robots" content="noindex, nofollow" />
<link rel="canonical" href="http://localhost:1313/404.html" />
<link rel="alternate" href="http://localhost:1313/404.html" hreflang="en-us" />
```

9
search_engine_optimization/archetypes/default.md Normal file
View File

@ -0,0 +1,9 @@
---
title: "{{ replace .Name "-" " " | title }}"
date: {{ .Date }}
draft: true
## Add this key with value 'false' for indexing by search engines enabled by default
private: false
---

5
search_engine_optimization/content/posts/example.md Normal file
View File

@ -0,0 +1,5 @@
+++
title = "Example Page"
...
private = true
+++