Skip to content

chore(docs): add markdownlint to CI #305

@marythought

Description

@marythought

Summary

Add markdownlint to the opentdf/docs project to enforce consistent markdown formatting across SDK documentation pages.

Motivation

SDK documentation pages have accumulated inconsistencies in table formatting, heading structure, and emphasis usage. A linter catches these automatically and prevents regressions.

Scope

  • Add .markdownlint.yaml config
  • Fix existing violations across SDK pages
  • Optionally add markdownlint to CI

Config highlights

  • MD033: allow MDX components (Tabs, TabItem, SdkVersion, etc.)
  • MD010: ignore tabs in code blocks (Go uses tabs)
  • MD013: disabled (line length not enforced)
  • MD041: disabled (MDX files start with frontmatter/imports)
  • MD060: enforce table column style

🤖 Generated with Claude Code

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