- commit
- 4bad293
- parent
- b2c19b1
- author
- Eric Bower
- date
- 2022-08-10 15:36:06 +0000 UTC
docs(prose): add help section for supported hugo variables
2 files changed,
+197,
-5
+196,
-4
1@@ -93,11 +93,15 @@ date: 2022-06-28
2 ---</pre>
3 </p>
4 <p>
5- List of available variables:
6+ List of available variables can be found <a href="#hugo-support">here</a>.
7+ </p>
8+ <p>
9+ Common variables:
10 <ul>
11 <li>title (custom title not dependent on filename)</li>
12 <li>description (what is the purpose of this post? It's also added to meta tag)</li>
13- <li>date (format must be YYYY-MM-DD)</li>
14+ <li>date (format must be YYYY-MM-DD, if set in future post wil be unlisted)</li>
15+ <li>tags (<code>[feature, announcement]</code>)</li>
16 </ul>
17 </p>
18 </section>
19@@ -163,7 +167,6 @@ scp ./delete.md {{.Site.Domain}}:/</pre>
20 <pre>---
21 title: some title!
22 description: this is a great description
23-tags: [feature, announcement]
24 nav:
25 - google: https://google.com
26 - site: https://some.site
27@@ -179,7 +182,6 @@ This will show up on the blog landing page.
28 <li>title (name of the blog, default: "X's blog")</li>
29 <li>description (description of blog)</li>
30 <li>nav (key=value pair that corresponds to text=href in html)</li>
31- <li>tags (e.g. [feature, announcement]</li>
32 </ul>
33 </p>
34 </section>
35@@ -274,6 +276,196 @@ This will show up on the blog landing page.
36 <p>Resulting in:</p>
37 <pre>_prose.subdomain.yourcustomdomain.com. 300 IN TXT "hey"</pre>
38 </section>
39+
40+ <section id="hugo-support">
41+ <h2 class="text-xl">
42+ <a href="#hugo-support" rel="nofollow noopener">#</a>
43+ Hugo support
44+ </h2>
45+ <p>
46+ We support a subset of pre-defined hugo variables in our frontmatter.
47+ <a href="https://gohugo.io/content-management/front-matter/">Complete list at Hugo</a>
48+ </p>
49+ <table>
50+ <th>
51+ <tr>
52+ <th align="left">Variable</th>
53+ <th>Supported</th>
54+ <th>Planned</th>
55+ </tr>
56+ </th>
57+
58+ <tbody>
59+ <tr>
60+ <td>aliases</td>
61+ <td>no</td>
62+ <td>yes</td>
63+ </tr>
64+
65+ <tr>
66+ <td>audio</td>
67+ <td>no</td>
68+ <td>no</td>
69+ </tr>
70+
71+ <tr>
72+ <td>cascade</td>
73+ <td>no</td>
74+ <td>no</td>
75+ </tr>
76+
77+ <tr>
78+ <td>date</td>
79+ <td>yes</td>
80+ <td>-</td>
81+ </tr>
82+
83+ <tr>
84+ <td>description</td>
85+ <td>yes</td>
86+ <td>-</td>
87+ </tr>
88+
89+ <tr>
90+ <td>draft</td>
91+ <td>no</td>
92+ <td>yes</td>
93+ </tr>
94+
95+ <tr>
96+ <td>expiryDate</td>
97+ <td>no</td>
98+ <td>no</td>
99+ </tr>
100+
101+ <tr>
102+ <td>headless</td>
103+ <td>no</td>
104+ <td>no</td>
105+ </tr>
106+
107+ <tr>
108+ <td>images</td>
109+ <td>no</td>
110+ <td>no</td>
111+ </tr>
112+
113+ <tr>
114+ <td>isCJKLanguage</td>
115+ <td>no</td>
116+ <td>no</td>
117+ </tr>
118+
119+ <tr>
120+ <td>keywords</td>
121+ <td>no</td>
122+ <td>yes</td>
123+ </tr>
124+
125+ <tr>
126+ <td>layout</td>
127+ <td>no</td>
128+ <td>maybe</td>
129+ </tr>
130+
131+ <tr>
132+ <td>lastmod</td>
133+ <td>no</td>
134+ <td>maybe</td>
135+ </tr>
136+
137+ <tr>
138+ <td>linkTitle</td>
139+ <td>no</td>
140+ <td>no</td>
141+ </tr>
142+
143+ <tr>
144+ <td>markup</td>
145+ <td>no</td>
146+ <td>no</td>
147+ </tr>
148+
149+ <tr>
150+ <td>outputs</td>
151+ <td>no</td>
152+ <td>no</td>
153+ </tr>
154+
155+ <tr>
156+ <td>publishDate</td>
157+ <td>no</td>
158+ <td>no</td>
159+ </tr>
160+
161+ <tr>
162+ <td>resources</td>
163+ <td>no</td>
164+ <td>no</td>
165+ </tr>
166+
167+ <tr>
168+ <td>series</td>
169+ <td>no</td>
170+ <td>no</td>
171+ </tr>
172+
173+ <tr>
174+ <td>slug</td>
175+ <td>no</td>
176+ <td>yes</td>
177+ </tr>
178+
179+ <tr>
180+ <td>summary</td>
181+ <td>no</td>
182+ <td>yes</td>
183+ </tr>
184+
185+ <tr>
186+ <td>tags</td>
187+ <td>yes</td>
188+ <td>-</td>
189+ </tr>
190+
191+ <tr>
192+ <td>title</td>
193+ <td>yes</td>
194+ <td>-</td>
195+ </tr>
196+
197+ <tr>
198+ <td>type</td>
199+ <td>no</td>
200+ <td>maybe</td>
201+ </tr>
202+
203+ <tr>
204+ <td>url</td>
205+ <td>no</td>
206+ <td>no</td>
207+ </tr>
208+
209+ <tr>
210+ <td>videos</td>
211+ <td>no</td>
212+ <td>no</td>
213+ </tr>
214+
215+ <tr>
216+ <td>weight</td>
217+ <td>no</td>
218+ <td>no</td>
219+ </tr>
220+
221+ <tr>
222+ <td>taxonomies</td>
223+ <td>no</td>
224+ <td>no</td>
225+ </tr>
226+ </tbody>
227+ </table>
228+ </section>
229 </main>
230 {{template "marketing-footer" .}}
231 {{end}}
+1,
-1
1@@ -138,7 +138,7 @@ Cya!
2 <h2 class="text-lg font-bold">Roadmap</h2>
3 <ol>
4 <li>Ability to upload images</li>
5- <li>Limited compatibility with <a href="https://gohugo.io">hugo</a></li>
6+ <li><a href="/help#hugo-support">Limited compatibility</a> with <a href="https://gohugo.io">hugo</a></li>
7 </ol>
8 </section>
9 </main>