Skip to content

Commit 1a86b5c

Browse files
CopilotjedudenCopilot
authored
Extend Markdown linters comparison page and link from README (#204)
* docs: extend linter comparison with Hugo, query, security, future plans Agent-Logs-Url: https://github.com/jeduden/mdsmith/sessions/71eb11d4-360d-4297-8a26-1800769b40ae Co-authored-by: jeduden <1117699+jeduden@users.noreply.github.com> * docs: merge rules-lacks table into structural linting with plan annotations Agent-Logs-Url: https://github.com/jeduden/mdsmith/sessions/bb8f681c-272f-45b5-90e0-70c7aed81522 Co-authored-by: jeduden <1117699+jeduden@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> * docs: use catalog directive for README comparison link; fix review issues; add Obsidian Agent-Logs-Url: https://github.com/jeduden/mdsmith/sessions/3991a7bc-82a8-4cb8-bcc2-78a21b8fe49a Co-authored-by: jeduden <1117699+jeduden@users.noreply.github.com> * docs: add plans 124-127 for missing rules (space-in-code, space-in-links, proper-names, single-H1) Agent-Logs-Url: https://github.com/jeduden/mdsmith/sessions/86a0ecef-882c-4f8e-b485-e94e86adbad1 Co-authored-by: jeduden <1117699+jeduden@users.noreply.github.com> * plan: add 128/129 for undefined and unused reference-link labels Agent-Logs-Url: https://github.com/jeduden/mdsmith/sessions/60d0ccb6-54d1-4e76-8ef2-45e329bf398b Co-authored-by: jeduden <1117699+jeduden@users.noreply.github.com> * plan: drop invalid `enabled:` config keys, fix spelling and message case Agent-Logs-Url: https://github.com/jeduden/mdsmith/sessions/9c7474b1-6cbb-474a-a72d-9f8390848936 Co-authored-by: jeduden <1117699+jeduden@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: jeduden <1117699+jeduden@users.noreply.github.com> Co-authored-by: Jan-Eric Duden <jeduden@gmail.com> Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
1 parent 0ef6d47 commit 1a86b5c

12 files changed

Lines changed: 1289 additions & 46 deletions

.github/copilot-instructions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ row: "- [{summary}](../{filename})"
2929
- [Shared patterns (archetypes) reused across multiple linting rules.](../docs/background/archetypes/README.md)
3030
- [How "flavor" (a property of the renderer), "rule" (a single check), "convention" (a project-wide bundle), and "kind" (a per-file role tag) differ in mdsmith, the cases where they overlap, and how the four concepts compose.](../docs/background/concepts/flavor-rule-convention-kind.md)
3131
- [How the placeholder vocabulary lets rules treat template tokens as opaque rather than flagging them as content violations.](../docs/background/concepts/placeholder-grammar.md)
32-
- [Comparison of mdsmith with other Markdown linters and formatters.](../docs/background/markdown-linters.md)
32+
- [How mdsmith compares to other Markdown linters.](../docs/background/markdown-linters.md)
3333
- [Codecov coverage gate and CI status checks.](../docs/development/coverage.md)
3434
- [Where to place Markdown files and documentation types.](../docs/development/file-placement.md)
3535
- [Build commands, project layout, code style, test fixtures, coverage gate, and merge conflicts.](../docs/development/index.md)

AGENTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ row: "- [{summary}]({filename})"
3535
- [Shared patterns (archetypes) reused across multiple linting rules.](docs/background/archetypes/README.md)
3636
- [How "flavor" (a property of the renderer), "rule" (a single check), "convention" (a project-wide bundle), and "kind" (a per-file role tag) differ in mdsmith, the cases where they overlap, and how the four concepts compose.](docs/background/concepts/flavor-rule-convention-kind.md)
3737
- [How the placeholder vocabulary lets rules treat template tokens as opaque rather than flagging them as content violations.](docs/background/concepts/placeholder-grammar.md)
38-
- [Comparison of mdsmith with other Markdown linters and formatters.](docs/background/markdown-linters.md)
38+
- [How mdsmith compares to other Markdown linters.](docs/background/markdown-linters.md)
3939
- [Codecov coverage gate and CI status checks.](docs/development/coverage.md)
4040
- [Where to place Markdown files and documentation types.](docs/development/file-placement.md)
4141
- [Build commands, project layout, code style, test fixtures, coverage gate, and merge conflicts.](docs/development/index.md)

CLAUDE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ row: "- [{summary}]({filename})"
2121
- [Shared patterns (archetypes) reused across multiple linting rules.](docs/background/archetypes/README.md)
2222
- [How "flavor" (a property of the renderer), "rule" (a single check), "convention" (a project-wide bundle), and "kind" (a per-file role tag) differ in mdsmith, the cases where they overlap, and how the four concepts compose.](docs/background/concepts/flavor-rule-convention-kind.md)
2323
- [How the placeholder vocabulary lets rules treat template tokens as opaque rather than flagging them as content violations.](docs/background/concepts/placeholder-grammar.md)
24-
- [Comparison of mdsmith with other Markdown linters and formatters.](docs/background/markdown-linters.md)
24+
- [How mdsmith compares to other Markdown linters.](docs/background/markdown-linters.md)
2525
- [Codecov coverage gate and CI status checks.](docs/development/coverage.md)
2626
- [Where to place Markdown files and documentation types.](docs/development/file-placement.md)
2727
- [Build commands, project layout, code style, test fixtures, coverage gate, and merge conflicts.](docs/development/index.md)

PLAN.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,12 @@ footer: |
3232
| 113 | 🔲 | sonnet | [User-defined Markdown conventions](plan/113_user-defined-profiles.md) |
3333
| 114 || sonnet | [MDS034 message clarity and flavor-vs-rule docs](plan/114_mds034-message-and-flavor-vs-rule-docs.md) |
3434
| 120 | 🔲 | sonnet | [Unify glob matcher and field naming across mdsmith](plan/120_glob-unification.md) |
35+
| 124 | 🔲 | sonnet | [No space inside code spans rule](plan/124_no-space-in-code-spans.md) |
36+
| 125 | 🔲 | sonnet | [No space inside link text rule](plan/125_no-space-in-link-text.md) |
37+
| 126 | 🔲 | sonnet | [Proper-name capitalization rule](plan/126_proper-names.md) |
38+
| 127 | 🔲 | sonnet | [Single H1 per file rule](plan/127_single-h1.md) |
39+
| 128 | 🔲 | sonnet | [Reject undefined reference-link labels](plan/128_no-undefined-reference-labels.md) |
40+
| 129 | 🔲 | sonnet | [Flag unused or duplicate link reference definitions](plan/129_no-unused-link-definitions.md) |
3541
| 52 || | [Archetype / Template Library for Agentic Patterns](plan/52_archetype-template-library.md) |
3642
| 61 || | [Required Structure Rule Hardening](plan/61_required-structure-hardening.md) |
3743
| 65 || | [Spike WASM-Embedded Weasel Inference](plan/65_spike-wasm-embedded-inference.md) |

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,15 @@ binary. No network calls. Drop the output into
6868
`.cursor/rules`, `AGENTS.md`, or `CLAUDE.md` and your
6969
agent knows the rules without an extra fetch.
7070

71+
**🆚 How does it compare?** See:
72+
<?catalog
73+
glob:
74+
- "docs/background/markdown-linters.md"
75+
row: "- [{summary}]({filename})"
76+
?>
77+
- [How mdsmith compares to other Markdown linters.](docs/background/markdown-linters.md)
78+
<?/catalog?>
79+
7180
## 📦 Installation
7281

7382
```bash

0 commit comments

Comments
 (0)