Skip to content

fix(docs): scope fenced code language linting#965

Merged
pimlock merged 2 commits intomainfrom
pm/fix-md-lint
Apr 24, 2026
Merged

fix(docs): scope fenced code language linting#965
pimlock merged 2 commits intomainfrom
pm/fix-md-lint

Conversation

@pimlock
Copy link
Copy Markdown
Collaborator

@pimlock pimlock commented Apr 24, 2026

Summary

Configure Markdown linting so bare fenced code blocks are allowed in internal docs while published docs under docs/ still require a language.

This keeps architecture and planning documents free to use bare fences for diagrams and terminal sketches, while preserving stricter rendering/copy behavior for user-facing Fern docs.

Example

Bare fence (no type). This is now allowed in internal docs.

```
Something
```

Fence with a type.

```text
Something
```

Changes

  • Disable MD040 in the root markdownlint config.
  • Re-enable MD040 in docs/.markdownlint-cli2.jsonc.

Testing

  • mise run markdown:lint:md passes
  • Verified a synthetic bare fence under docs/ still fails MD040
  • Unit tests added/updated
  • E2E tests added/updated (if applicable)

Checklist

  • Follows Conventional Commits
  • Commits are signed off (DCO)
  • Architecture docs updated (if applicable)

@pimlock pimlock requested a review from a team as a code owner April 24, 2026 19:11
@pimlock pimlock changed the title fix(docs): fix markdown formatting after linting was introduced fix(docs): fix markdown lint failure Apr 24, 2026
@pimlock pimlock changed the title fix(docs): fix markdown lint failure fix(docs): scope fenced code language linting Apr 24, 2026
@github-actions
Copy link
Copy Markdown

@pimlock pimlock merged commit a01b6dd into main Apr 24, 2026
22 checks passed
@pimlock pimlock deleted the pm/fix-md-lint branch April 24, 2026 21:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants