Rule - MD044

Property	Value
Aliases	md044, proper-names
Autofix Available	Yes
Enabled By Default	Yes

Summary

Proper names should have the correct capitalization.

Reasoning

Consistency

Quite often, when writing groups of documents, there are certain proper nouns that have specific capitalization. A good example of this is the proper PyMarkdown. It very specifically has the P and M characters capitalized. This rule allows for that capitalization to be enforced.

Examples

Failure Scenarios

This rule triggers when this rule finds any standalone instance of a word specified in the names configuration value that does not have a correct capitalization. Assuming names is set to ParaGraph, then the following example will trigger this rule:

Markdown this is a paragraph.

There are also special rules for how this rule triggers on links and images. For inline links and inline images, this rule triggers on matching text in the link label and the link title, but not the link URI:

Markdown this is a [paragraph](/paragraph "a paragraph item") link.

The rule triggers on that example for the first occurrence of paragraph (link label) and the last occurrence (link title).

For every other type of link and image, this rule triggers on any occurrence in the link label.

```Markdown ![collapsed paragraph][] link

```

Since any link title is physically associated with the Link Reference Definition, any occurrence found in the link title triggers this rule.

Correct Scenarios

This rule does not trigger if it cannot find any of the words present in the names configuration value. This rule also does not trigger if any of those words are found but are correctly capitalized. Assuming names is set to ParaGraph, then the following example will not trigger this rule:

Markdown this is a ParaGraph.

In addition, this rule does not trigger if the found text is not an isolated word within the text. For example, even if names is set to ParaGraph, the following lines of text will not trigger this rule:

Markdown this is a paragraphing this is a reparagraph

Fix Description

The specified word is replaced by the properly cased word presented in the configuration item.

Configuration

Prefixes
plugins.md044.
plugins.proper-names.

Value Name	Type	Default	Description
enabled	boolean	True	Whether the Rule Plugin is enabled.
names	string	None	Comma-separated list of proper nouns to preserve capitalization on.**
code_blocks	boolean	True	Search in Fenced Code Block elements and Indented Code Block elements.
code_spans	boolean	True	Search in Inline Code Span elements.

** The comma-separated list of items is a string with a format of {item},...,{item}. Any leading or trailing space characters surrounding the {item} are trimmed during processing. Any empty {item} value left after this trimming has been applied will generate a configuration error.

Origination of Rule

This rule is largely inspired by the MarkdownLint rule MD044.