added support for the meta description tag (#57)

* added support for the meta description tag * Update meta description logic for single page Co-authored-by: hossainemruz <emruz@appscode.com>
hugo-toha · Aug 6, 2020 · 5f48a5b · 5f48a5b
1 parent 629c719
commit 5f48a5b
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -75,9 +75,12 @@ enableEmoji: true
 
 # Custom parameters
 params:
-  # copyright
+  # Copyright Notice
   copyright: © 2020 Copyright.
 
+  # Meta description for your site.  This will help the search engines to find your site.
+  description: Portfolio and personal blog of Jane Doe.
+
   # background image of the landing page
   background: "images/background.jpg"
 

diff --git a/exampleSite/config.yaml b/exampleSite/config.yaml
@@ -24,9 +24,12 @@ enableEmoji: true
 
 # Custom parameters
 params:
-  # copyright
+  # Copyright Notice
   copyright: © 2020 Copyright.
 
+  # Meta description for your site.  This will help the search engines to find your site.
+  description: Portfolio and personal blog of Jane Doe.
+
   # background image of the landing page
   background: "images/background.jpg"
 

diff --git a/layouts/_default/single.html b/layouts/_default/single.html
@@ -1,4 +1,5 @@
 {{ define "header" }}
+<meta name="description" content="{{ if .Description }}{{ .Description }}{{ else }}{{ .Title }}{{ end }}" />
 <link
   rel="stylesheet"
   href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.1/styles/atom-one-dark.min.css"
@@ -36,23 +37,23 @@
       <!--Hero Area-->
       <div class="hero-area col-sm-12" id="hero-area" style='background-image: url({{ strings.TrimSuffix "/" .Site.BaseURL }}{{ partial "helpers/get-hero.html" . }});'>
       </div>
-  
+
       <!--Content Start-->
       <div class="page-content">
         <div class="author-profile ml-auto align-self-lg-center">
           <img class="rounded-circle" src='{{ partial "helpers/get-author-image.html" . }}'/>
           <h5 class="author-name">{{ partial "helpers/get-author-name.html" . }}</h5>
           <p>{{ .Page.Date.Format "January 2, 2006" }}</p>
         </div>
-  
+
         <div class="title">
           <h1>{{ .Page.Title }}</h1>
         </div>
-  
+
         <div class="post-content" id="post-content">
           {{ .Page.Content }}
         </div>
-  
+
         <!--- Improve this page button --->
         {{ if .Site.Params.GitRepo }}
           <div class="btn-improve-page">
@@ -62,7 +63,7 @@ <h1>{{ .Page.Title }}</h1>
               </a>
           </div>
         {{ end }}
-  
+
         <!---Next and Previous Navigator -->
       <hr />
         {{ partial "navigators/next-prev-navigator.html" . }}

diff --git a/layouts/index.html b/layouts/index.html
@@ -2,6 +2,7 @@
 <html lang="en">
   <head>
     <title>{{- .Site.Title -}}</title>
+    <meta name="description" content="{{ .Site.Params.description }}" />
     <!-- import common headers -->
     {{- partial "header.html" . -}}