Andreas/markdownlint
1
0
Fork 0
mirror of https://github.com/DavidAnson/markdownlint.git synced 2025-09-21 21:30:47 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

Update documentation for MD044/proper-names to show how to handle differing capitalization (closes #1288).

Browse source
This commit is contained in:
David Anson 2024-07-12 08:20:14 +00:00
parent 6912c12847
commit 4fd1b05021
3 changed files with 30 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

10
doc-build/md044.md
View file

@ -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
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