Skip to content

Remove markdownlint exclusion for collections/*.collection.md #1341

@WilliamBerryiii

Description

@WilliamBerryiii

Summary

The .markdownlint-cli2.jsonc configuration (line 12) excludes collections/*.collection.md from linting. This exclusion should be removed by fixing the underlying lint violations so these auto-generated files pass the full linting pipeline.

Context

During work on #1256 / PR #1316, the exclusion was investigated for removal. Running markdownlint against these files produces 23 errors across the collection:

Rule Count Description
search-replace/no-em-dash 21 Em dash () in frontmatter description fields
MD041 1 First line is not a top-level heading
MD013 1 Line length exceeds configured limit

The cleanup was deferred to keep PR #1316 focused on its original scope.

Scope

  1. Fix 21 no-em-dash violations — Replace em dashes in frontmatter description fields across collections/*.collection.md files with compliant alternatives (hyphens or rephrased text).
  2. Fix MD041 violation — Ensure every collection.md file starts with a top-level heading.
  3. Fix MD013 violation — Wrap or shorten the offending long line.
  4. Remove the exclusion from .markdownlint-cli2.jsonc line 12.
  5. Update references to this exclusion in:
    • scripts/linting/Validate-MarkdownFrontmatter.ps1 (line 36 area)
    • .github/copilot-instructions.md (line 105 area, if still referencing the exclusion)
  6. Regenerate plugin outputs — Run npm run plugin:generate after changes to confirm pipeline still passes.

Related

Acceptance Criteria

  • npx markdownlint-cli2 "collections/*.collection.md" produces zero errors
  • .markdownlint-cli2.jsonc no longer excludes collections/*.collection.md
  • npm run plugin:generate and npm run plugin:postprocess pass cleanly
  • npm run lint:md passes with no regressions

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions