@@ -12,19 +12,19 @@ This page provides a quick-start template for new documentation pages. Be sure t
12
12
13
13
** On this page** :
14
14
15
- * Table of contents
15
+ * Contents
16
16
{: toc }
17
17
18
- ## Template markup
18
+ ## Using the template
19
19
20
20
To use the template:
21
21
22
- 1 ) Create a new Markdown page ( having file extension, * .md* ) .
22
+ 1 ) Create a new Markdown page having file extension, * .md* .
23
23
24
- 2 ) Save it in the appropriate directory location using one of these file-name patterns, as required :
24
+ 2 ) Save it in the appropriate directory location using one of the following file-name patterns, respectively :
25
25
26
- * If it’s a page for a new Textpattern tag , use this underscore pattern : * file_name_for_page.md* .
27
- * For all other pages in the documentation website , use this hyphenated pattern : * file-name-for-page.md* .
26
+ * If a tag page in the Tag Reference , use underscores : * file_name_for_page.md* .
27
+ * For all other pages in user docs , use hyphens : * file-name-for-page.md* .
28
28
29
29
3 ) Copy the following block of code (the minimum template markup) and paste it in your new blank page. Adjust to your needs.
30
30
@@ -72,9 +72,9 @@ Normal text.
72
72
```
73
73
74
74
75
- ## Template explanation
75
+ ## Explanation
76
76
77
- A quick breakdown of the markup elements .
77
+ Elaboration on each template element .
78
78
79
79
### Metadata
80
80
@@ -107,8 +107,8 @@ As example, the metadata block for the user documentation guidelines:
107
107
layout: document
108
108
category: brand
109
109
published: true
110
- title: Textpattern user documentation guidelines
111
- description: Guidelines for contributions to Textpattern CMS user documentation.
110
+ title: Development guidelines for Textpattern documentation
111
+ description: Guidelines for the development of Textpattern user documentation.
112
112
---
113
113
```
114
114
@@ -137,7 +137,7 @@ The contents list begins with a consistent lead line, followed by the Kramdown s
137
137
```
138
138
**On this page:**
139
139
140
- * Table of contents
140
+ * Contents
141
141
{:toc}
142
142
```
143
143
0 commit comments