Skip to content

MD013 line-length limit of 120 characters is too strict for device documentation #6700

@dima-zhemkov

Description

@dima-zhemkov

Problem

The Markdown linting rule MD013 enforces a 120-character line length limit, which is overly restrictive for device
documentation pages. This creates readability and formatting issues:

  1. Technical descriptions: Complex sentences describing hardware features, pin functions, and specifications
    naturally exceed 120 chars and cannot be meaningfully broken into shorter lines without creating awkward sentence
    fragments.

  2. Table entries: GPIO pinout tables and other structured data often have long descriptive text that cannot be
    wrapped without breaking table formatting.

  3. URLs and code references: Links to documentation and code examples frequently exceed
    the limit when included in sentences.

  4. Maintainability: The restriction forces artificial line breaks that make the markdown source harder to edit
    and maintain without providing any real readability benefit in the rendered HTML.

Suggested Solution

Disable MD013 for device documentation files.

Current Behavior

Device page validation rejects otherwise well-written documentation solely because lines exceed 120 characters.

Expected Behavior

Device pages should pass validation if they follow all other style guidelines, regardless of line length (within reason).

URL

https://devices.esphome.io/

Additional information

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions