mirror of
https://github.com/DavidAnson/markdownlint.git
synced 2025-09-22 05:40:48 +02:00
Update documentation for MD044/proper-names to show how to handle differing capitalization (closes #1288).
This commit is contained in:
parent
6912c12847
commit
4fd1b05021
3 changed files with 30 additions and 0 deletions
|
@ -13,6 +13,16 @@ enforce the proper capitalization, specify the desired letter case in the
|
||||||
]
|
]
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Sometimes a proper name is capitalized differently in certain contexts. In such
|
||||||
|
cases, add both forms to the `names` array:
|
||||||
|
|
||||||
|
```json
|
||||||
|
[
|
||||||
|
"GitHub",
|
||||||
|
"github.com"
|
||||||
|
]
|
||||||
|
```
|
||||||
|
|
||||||
Set the `code_blocks` parameter to `false` to disable this rule for code blocks
|
Set the `code_blocks` parameter to `false` to disable this rule for code blocks
|
||||||
and spans. Set the `html_elements` parameter to `false` to disable this rule
|
and spans. Set the `html_elements` parameter to `false` to disable this rule
|
||||||
for HTML elements and attributes (such as when using a proper name as part of
|
for HTML elements and attributes (such as when using a proper name as part of
|
||||||
|
|
10
doc/Rules.md
10
doc/Rules.md
|
@ -1834,6 +1834,16 @@ enforce the proper capitalization, specify the desired letter case in the
|
||||||
]
|
]
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Sometimes a proper name is capitalized differently in certain contexts. In such
|
||||||
|
cases, add both forms to the `names` array:
|
||||||
|
|
||||||
|
```json
|
||||||
|
[
|
||||||
|
"GitHub",
|
||||||
|
"github.com"
|
||||||
|
]
|
||||||
|
```
|
||||||
|
|
||||||
Set the `code_blocks` parameter to `false` to disable this rule for code blocks
|
Set the `code_blocks` parameter to `false` to disable this rule for code blocks
|
||||||
and spans. Set the `html_elements` parameter to `false` to disable this rule
|
and spans. Set the `html_elements` parameter to `false` to disable this rule
|
||||||
for HTML elements and attributes (such as when using a proper name as part of
|
for HTML elements and attributes (such as when using a proper name as part of
|
||||||
|
|
10
doc/md044.md
10
doc/md044.md
|
@ -27,6 +27,16 @@ enforce the proper capitalization, specify the desired letter case in the
|
||||||
]
|
]
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Sometimes a proper name is capitalized differently in certain contexts. In such
|
||||||
|
cases, add both forms to the `names` array:
|
||||||
|
|
||||||
|
```json
|
||||||
|
[
|
||||||
|
"GitHub",
|
||||||
|
"github.com"
|
||||||
|
]
|
||||||
|
```
|
||||||
|
|
||||||
Set the `code_blocks` parameter to `false` to disable this rule for code blocks
|
Set the `code_blocks` parameter to `false` to disable this rule for code blocks
|
||||||
and spans. Set the `html_elements` parameter to `false` to disable this rule
|
and spans. Set the `html_elements` parameter to `false` to disable this rule
|
||||||
for HTML elements and attributes (such as when using a proper name as part of
|
for HTML elements and attributes (such as when using a proper name as part of
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue