Browse Source

docs(feature/custom-homepage): enhance detail and add internal link

Josh Habdas 5 months ago
parent
commit
4d053b24ca
Signed by: Josh Habdas <jhabdas@protonmail.com> GPG Key ID: B148B31154C75A74
2 changed files with 16 additions and 10 deletions
  1. 15
    9
      docs/content/feature/custom-homepage.md
  2. 1
    1
      docs/content/feature/structured-data.md

+ 15
- 9
docs/content/feature/custom-homepage.md View File

@@ -1,8 +1,8 @@
1 1
 +++
2 2
 title = "Custom Homepage"
3
-description = "Hide the blog and specify the content shown."
3
+description = "Hide the blog and specify how content is shown."
4 4
 categories = ["customizing"]
5
-tags = ["layout", "templating", "style"]
5
+tags = ["layout", "templating", "style", "metadata", "semantics", "robots"]
6 6
 features = ["code highlighter", "snippets", "related content"]
7 7
 [[copyright]]
8 8
   owner = "Josh Habdas"
@@ -77,14 +77,14 @@ And use the space to add more sections:
77 77
   type = "podcast"
78 78
 ```
79 79
 
80
-Or even add stand-alone pages too:
80
+Or add stand-alone pages too:
81 81
 
82 82
 ```toml
83 83
 [[params.layout.home.section]]
84 84
   type = "about"
85 85
 ```
86 86
 
87
-And display sections in order by weight:
87
+And display them in order by weight:
88 88
 
89 89
 ```toml
90 90
 [[params.layout.home.section]]
@@ -96,7 +96,7 @@ And display sections in order by weight:
96 96
   weight = 2
97 97
 ```
98 98
 
99
-Each section is output using generic [Structured Data](../structured-data):
99
+With each section containing generic [Structured Data](../structured-data):
100 100
 
101 101
 ```
102 102
 Homepage
@@ -107,7 +107,7 @@ Homepage
107 107
     └── Thing
108 108
 ```
109 109
 
110
-And may be enhanced using front matter:
110
+Which may be enhanced using front matter:
111 111
 
112 112
 ```
113 113
 ├── archetypes
@@ -122,11 +122,15 @@ And may be enhanced using front matter:
122 122
 ```
123 123
 
124 124
 ```toml
125
+title = "About"
126
+description = "Information about the site."
125 127
 [schema]
126 128
   type = "AboutPage" # inside about.md
127 129
 ```
128 130
 
129 131
 ```toml
132
+title = "Podcasts"
133
+description = "Live on the Web. Fresh to your head."
130 134
 [schema]
131 135
   type = "Audiobook" # inside _index.md
132 136
 ```
@@ -142,7 +146,9 @@ Homepage
142 146
     └── Audiobook
143 147
 ```
144 148
 
145
-Which can be further enhanced using thumbnail images, which are output automatically for any list item in any section using a [Post Images](../post-images) formatted resource bundle and containing the string `thumbnail`:
149
+Including `name` and `description` properties consistent between what's shown to users and what will appear in <abbr title="Search Engine Results Page">SERP</abbr>s.
150
+
151
+Item lists may include thumbnail images generated automatically for any `ItemList` element using a [Post Images](../post-images)-formatted resource bundle and containing `thumbnail` in the name:
146 152
 
147 153
 ```toml
148 154
 [[resources]]
@@ -150,7 +156,7 @@ Which can be further enhanced using thumbnail images, which are output automatic
150 156
   name = "header thumbnail"
151 157
 ```
152 158
 
153
-Thumbnails output automatically when described in front-matter for any resource type in any section, and may be manipulated using {{< external "https://gohugo.io/content-management/image-processing/#readout" "Hugo Image Processing" />}} using the `thumbs` setting in any section:
159
+Images include high-performance defaults and may be modified using {{< external "https://gohugo.io/content-management/image-processing/#readout" "Hugo Image Processing" />}} via config using the `thumbs` property in site config:
154 160
 
155 161
 ```toml
156 162
 [[params.layout.home.section]]
@@ -158,4 +164,4 @@ Thumbnails output automatically when described in front-matter for any resource
158 164
   thumbs = ["fill", "400x400"]
159 165
 ```
160 166
 
161
-Valid options are `fit`, `resize` and `fill`, and image dimensions may be omitted for a 4x3 aspect ratio thumbnail.
167
+Valid image processing options are `fit`, `resize` and `fill`, and image dimensions may be omitted for a 4x3 aspect ratio thumbnail.

+ 1
- 1
docs/content/feature/structured-data.md View File

@@ -10,7 +10,7 @@ features = ["related content"]
10 10
   license = "agpl-3.0-or-later"
11 11
 +++
12 12
 
13
-After Dark generates structured metadata using {{< external "https://schema.org" />}} specifications for blog posts, [Section Menu](../section-menu), [Hall of Mirrors](/module/hall-of-mirrors) image galleries and adapts data automatically using author-defined [Post Bylines](../post-bylines) as shown here:
13
+After Dark generates structured metadata using {{< external "https://schema.org" />}} specifications for [Custom Homepage](../custom-homepage), [Section Menu](../section-menu), [Image Galleries](/module/hall-of-mirrors) and adapts data automatically using author-defined [Post Bylines](../post-bylines) as shown here:
14 14
 
15 15
 Schema Property | Frontmatter Value
16 16
 --------------- | -----------------

Loading…
Cancel
Save