@@ -24,7 +24,8 @@ Basic formatting guidelines:
24
24
25
25
- Limit lines to 80 characters
26
26
- Code blocks should be limited to 76 characters
27
- - Within a paragraph, the following characters must be escaped using a leading ` \ ` character: $,\` ,\<
27
+ - Within a paragraph, the following characters must be escaped using a leading ` \ ` character:
28
+ <code >$</code >, <code >\` </code >, <code >\< </code >
28
29
- Tables need fit withing 76 characters
29
30
- Manually wrap contents of cells across multiple lines
30
31
- Use opening and closing ` | ` characters on each line
@@ -59,13 +60,13 @@ Remove extra spaces at the end of lines.
59
60
60
61
## Titles/Headings
61
62
62
- Only use [ ATX headings] [ atx ] (as opposed to = or \- style headers).
63
+ Only use [ ATX headings] [ atx ] (# style, as opposed to = or \- style headers).
63
64
64
65
* Titles/headings should be surrounded by blank lines
65
66
* Only the first letter of a title and any proper nouns in that title should be capitalized
66
67
* Only one H1 per document
67
68
68
- When editing reference content, the H2s are prescribed by platyPS and must not be added or removed.
69
+ When editing reference content, the H2s are prescribed by [ platyPS] [ platyPS ] and must not be added or removed.
69
70
Adding or removing H2 causes a build break.
70
71
71
72
## Formatting syntax elements
@@ -85,7 +86,7 @@ Adding or removing H2 causes a build break.
85
86
86
87
## Formatting code blocks
87
88
88
- * All PowerShell syntax blocks should use &# 96 ;&# 96 ;&# 96 ; powershell code fence marker .
89
+ * All PowerShell syntax blocks should use < code > \`\`\` powershell</ code > & hellip ; < code > \`\`\` </ code > code fence markers .
89
90
90
91
* Do ** NOT** start PowerShell commands with the PowerShell prompt ("` PS C:\> ` ").
91
92
@@ -168,4 +169,5 @@ There are special rules for linking to reference topics from conceptual topics.
168
169
[ about-example ] : https://github.com/PowerShell/PowerShell-Docs/blob/staging/reference/5.1/Microsoft.PowerShell.Core/About/about_Comparison_Operators.md
169
170
[ links ] : https://help.github.com/articles/relative-links-in-readmes/
170
171
[ gfm-spec ] : https://github.github.com/gfm/
171
- [ semantics ] : http://rhodesmill.org/brandon/2012/one-sentence-per-line/
172
+ [ semantics ] : http://rhodesmill.org/brandon/2012/one-sentence-per-line/
173
+ [ platyPS ] : https://github.com/PowerShell/platyPS
0 commit comments