MD044 - proper-names¶
Description¶
This rule checks that proper names (like product or project names) are capitalized consistently throughout the document. The expected capitalization is specified in the names configuration option. For example:
names = ["JavaScript", "Github", "Python"]
Rationale¶
Inconsistent capitalization of proper names looks unprofessional and can confuse readers. Using the correct capitalization shows attention to detail and respect for the named entity.
Configuration¶
names-
List of proper names with correct capitalization.
- Default:
[](empty)
- Default:
code_blocks-
Whether to check inside code blocks and inline code.
- Default:
true
- Default:
html_elements-
Whether to check inside HTML elements.
- Default:
true
- Default:
Examples¶
Invalid¶
# Invalid Document
This document uses javascript incorrectly.
We also use github and python with improper capitalization.
- javascript is great
- github is useful
- python is powerful
Valid¶
# Valid Document
This document uses JavaScript correctly.
We also use GitHub and Python with proper capitalization.
- JavaScript is great
- GitHub is useful
- Python is powerful