Skip to content

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"]

Code blocks and inline code are skipped unless code_blocks is enabled. URLs, email addresses, link destinations, reference labels, and names right after a dot (as in config.toml or www.github.com) are never checked, so fixes cannot break links or file names.

Fixable: Yes

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)
code_blocks

Whether to check inside code blocks and inline code.

  • Default: false
html_elements

Whether to check inside HTML elements.

  • Default: true

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