Skip to content

Commit 38d64d4

Browse files
SamBSean Wheeler
authored and
Sean Wheeler
committed
Style tweaks in STYLE.md (#1913)
1 parent 1e0c256 commit 38d64d4

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

contributing/STYLE.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,8 @@ Basic formatting guidelines:
2424

2525
- Limit lines to 80 characters
2626
- 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>
2829
- Tables need fit withing 76 characters
2930
- Manually wrap contents of cells across multiple lines
3031
- Use opening and closing `|` characters on each line
@@ -59,13 +60,13 @@ Remove extra spaces at the end of lines.
5960

6061
## Titles/Headings
6162

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).
6364

6465
* Titles/headings should be surrounded by blank lines
6566
* Only the first letter of a title and any proper nouns in that title should be capitalized
6667
* Only one H1 per document
6768

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.
6970
Adding or removing H2 causes a build break.
7071

7172
## Formatting syntax elements
@@ -85,7 +86,7 @@ Adding or removing H2 causes a build break.
8586

8687
## Formatting code blocks
8788

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.
8990

9091
* Do **NOT** start PowerShell commands with the PowerShell prompt ("`PS C:\>`").
9192

@@ -168,4 +169,5 @@ There are special rules for linking to reference topics from conceptual topics.
168169
[about-example]: https://github.com/PowerShell/PowerShell-Docs/blob/staging/reference/5.1/Microsoft.PowerShell.Core/About/about_Comparison_Operators.md
169170
[links]: https://help.github.com/articles/relative-links-in-readmes/
170171
[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

Comments
 (0)