summaryrefslogtreecommitdiffstats
path: root/exampleSite/content
diff options
context:
space:
mode:
authorSerghei Iakovlev <egrep@protonmail.ch>2022-07-13 01:44:35 +0200
committerSerghei Iakovlev <egrep@protonmail.ch>2022-07-13 01:44:35 +0200
commitbde2ea493cee4c554a5fa80e07889e2d62576995 (patch)
tree8cb96ae22323787a33cc1647f4714cd1f807dc24 /exampleSite/content
parent26d53eef3ab0d5644a73a1f3cf0b9480dd2fe459 (diff)
downloadgohugo-theme-ed-bde2ea493cee4c554a5fa80e07889e2d62576995.tar.gz
Update documentation
Diffstat (limited to 'exampleSite/content')
-rw-r--r--exampleSite/content/documentation/index.md26
1 files changed, 22 insertions, 4 deletions
diff --git a/exampleSite/content/documentation/index.md b/exampleSite/content/documentation/index.md
index eac5c9c..8797571 100644
--- a/exampleSite/content/documentation/index.md
+++ b/exampleSite/content/documentation/index.md
@@ -1,7 +1,7 @@
---
title: Documentation
author: Alex Gil
-featured_image: screenshot-home.png
+featuredImage: screenshot-home.png
---
{{< toc >}}
@@ -74,16 +74,34 @@ Ed is a Hugo theme. That means you will need some familiarity with Hugo to take
Once you have gone through these tutorials, you can get started using Ed. Remember to always and only edit content files for your site using [a plain text editor](https://en.wikipedia.org/wiki/Text_editor), and *not* a word processor. I'm composing this file using a plain text editor called [Visual Studio Code](https://code.visualstudio.com/).
-You should make sure that all your texts have the YAML front matter (the information at the top of the file). YAML stands for "YAML Ain't Markup Language" --- no disrespect to XML --- and it's the main way that Hugo handles named data. Here's an example of YAML front matter:
+You should make sure that all your texts have the YAML [Front Matter](https://gohugo.io/content-management/front-matter/) (the information at the top of the file). YAML stands for "YAML Ain't Markup Language" --- no disrespect to XML --- and it's the main way that Hugo handles named data. Here's an example of YAML Front Matter:
~~~ yaml
---
+# Common-Defined params
title: "Cahier d'un retour au pays natal"
-author: Aimé Césaire
-draft: true
+draft: true # Is this text a draft?
+tags:
+ - Tag
+ - "Another tag"
+date: 2022-02-01T14:56:58+02:00
+lastmod: 2022-05-01T14:56:58+02:00
+
+# Theme-Defined params
+author: Aimé Césaire # Author of the text
+editor: Alex Gil # Editor of the text
+source: Project Guttenberg # The source of the text
+rights: Public Domain # Rights for this text
+pageTitle: Hello! # The title for the content w/o setting <title> tag
+toc: true # Enable Table of Contents for specific page
+private: true # Hide text from search engines
+semanticType: about # Semantic type of the work (used for Schema.org)
+featuredImage: screenshot-home.png # Featured image of the text
---
~~~
+For more information about all available standard front matter variables, please read [Hugo Front Matter](https://gohugo.io/content-management/front-matter/).
+
---
## Markdown and CommonMark