Skip to content

Commit 4ae6700

Browse files
authored
Fix typos (#351)
* Fix typos * Upcase code fence label
1 parent abb716f commit 4ae6700

File tree

1 file changed

+14
-11
lines changed

1 file changed

+14
-11
lines changed

reference/docs-conceptual/PlatyPS/step-2-edit-markdown-help.md

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ publishing system you use to create a website might require additional metadata.
8484

8585
The H1 title must match the cmdlet name exactly. Example:
8686

87-
```markdown
87+
```Markdown
8888
# Get-Widget
8989
```
9090

@@ -95,7 +95,7 @@ sentence, preferably on a single line.
9595

9696
Example:
9797

98-
```markdown
98+
```Markdown
9999
## SYNOPSIS
100100

101101
Gets one or more widgets based on specified criteria.
@@ -110,20 +110,21 @@ title of the H3 section is the name of the parameter set.
110110

111111
Example:
112112

113-
~~~markdown
113+
``````Markdown
114114
## SYNTAX
115115

116116
### DefaultParameterSet
117117

118118
```
119119
Get-Widget [-Name] <string> [-Color <ConsoleColor>] [-Size <int>] [<CommonParameters>]
120+
```
120121

121122
## DetailedParameterSet
122123

123124
```
124125
Get-Widget [-Name] <string> [-Color <ConsoleColor>] [-Size <int>] [-Detailed] [<CommonParameters>]
125126
```
126-
~~~
127+
``````
127128

128129
### H2 ALIASES
129130

@@ -132,7 +133,7 @@ can remove this section. This is the only optional section in the file.
132133

133134
Example:
134135

135-
```
136+
```Markdown
136137
## ALIASES
137138

138139
This cmdlet has the following aliases:
@@ -158,13 +159,15 @@ examples that require multiple code blocks with separate explanations.
158159

159160
Example:
160161

161-
~~~markdown
162+
``````Markdown
163+
## EXAMPLES
164+
162165
### Example 1 - Get a widget by name
163166

164167
```powershell
165168
Get-Widget -Name "Widget1"
166169
```
167-
~~~
170+
``````
168171

169172
### H2 PARAMETERS
170173

@@ -174,7 +177,7 @@ is documented in its own H3 section. The title of the H3 section is the name of
174177

175178
Example:
176179

177-
``````markdown
180+
``````Markdown
178181
### -Color
179182

180183
Filter the results by the color of the widget.
@@ -225,7 +228,7 @@ H2 header is required.
225228

226229
Example:
227230

228-
```markdown
231+
```Markdown
229232
## INPUTS
230233

231234
### System.String
@@ -242,7 +245,7 @@ doesn't return any objects, the section can be empty, but the H2 header is requi
242245

243246
Example:
244247

245-
```markdown
248+
```Markdown
246249
## OUTPUTS
247250

248251
### Widget
@@ -269,7 +272,7 @@ The RELATED LINKS section contains links to related topics. The section can be e
269272
header is required. The links should be formatted as a bulleted list of Markdown links. This section
270273
should not contain any other content.
271274

272-
```markdown
275+
```Markdown
273276
## RELATED LINKS
274277

275278
- [All about widgets](https://docs.tailspintoys.com/widgets)

0 commit comments

Comments
 (0)