|
1 | 1 | # Style Guide
|
2 | 2 |
|
3 |
| -* Documents are written in markdown files. |
4 |
| -* Those files should be written in **`lowercase-with-dashes.md`**. |
| 3 | +* Documentation is written in markdown files with names formatted as |
| 4 | + `lowercase-with-dashes.md`. |
5 | 5 | * Underscores in filenames are allowed only when they are present in the
|
6 | 6 | topic the document will describe (e.g., `child_process`).
|
7 |
| - * Filenames should be **lowercase**. |
8 | 7 | * Some files, such as top-level markdown files, are exceptions.
|
9 | 8 | * Documents should be word-wrapped at 80 characters.
|
10 | 9 | * The formatting described in `.editorconfig` is preferred.
|
|
19 | 18 | * Generally avoid personal pronouns in reference documentation ("I", "you",
|
20 | 19 | "we").
|
21 | 20 | * Pronouns are acceptable in more colloquial documentation, like guides.
|
22 |
| - * Use **gender-neutral pronouns** and **mass nouns**. Non-comprehensive |
| 21 | + * Use gender-neutral pronouns and mass nouns. Non-comprehensive |
23 | 22 | examples:
|
24 |
| - * **OK**: "they", "their", "them", "folks", "people", "developers", "cats" |
25 |
| - * **NOT OK**: "his", "hers", "him", "her", "guys", "dudes" |
| 23 | + * OK: "they", "their", "them", "folks", "people", "developers", "cats" |
| 24 | + * NOT OK: "his", "hers", "him", "her", "guys", "dudes" |
26 | 25 | * When combining wrapping elements (parentheses and quotes), terminal
|
27 | 26 | punctuation should be placed:
|
28 | 27 | * Inside the wrapping element if the wrapping element contains a complete
|
|
54 | 53 | is necessary, include it as an asset in `assets/code-examples` and link to
|
55 | 54 | it.
|
56 | 55 | * When using underscores, asterisks, and backticks, please use proper escaping
|
57 |
| - (**\\\_**, **\\\*** and **\\\`** instead of **\_**, **\*** and **\`**). |
| 56 | + (`\_`, `\*` and ``\` `` instead of `_`, `*` and `` ` ``). |
58 | 57 | * References to constructor functions should use PascalCase.
|
59 | 58 | * References to constructor instances should use camelCase.
|
60 | 59 | * References to methods should be used with parentheses: for example,
|
|
0 commit comments