Rule - MD010

Property	Value
Aliases	md010, no-hard-tabs
Autofix Available	Yes
Enabled By Default	Yes

Summary

Hard tabs.

Reasoning

Consistency

The primary reason for enabling this rule is to force Markdown writers to be explicit about their intent with the document. As different editors and different parsers may treat tab characters differently, the interpretation of a tab character's effect on a line depends on what editor or parser is used to interpret the Markdown text. By enabling this rule, the Markdown writer is forced to explicitly state their intentions for document indentation without any perceived ambiguity.

Examples

Failure Scenarios

This rule triggers when any line of the document has a hard tab character. A simple example is:

Markdown {tab}Indented Code Block

where the sequence {tab} is replaced with an actual tab character. If multiple tab characters are present, each occurrence of a tab character will trigger this rule independently.

Correct Scenarios

To correct the above example, simply enforce the required indentation using space characters:

Markdown Indented Code Block

Fix Description

Except for within code blocks, any tab characters will be replaced with the appropriate count of space characters. Note that tab characters within Markdown documents are treated as Tab Stops and not blindly replaced with 4 space characters per tab character. For more clarity, please read the specification at the above link.

Configuration

Prefixes
plugins.md010.
plugins.no-hard-tabs.

Value Name	Type	Default	Description
enabled	boolean	True	Whether the Rule Plugin is enabled.
code_blocks	boolean	True	Whether hard tabs are searched for within code blocks.

Origination of Rule

This rule is largely inspired by the MarkdownLint rule MD010.