You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+4-289Lines changed: 4 additions & 289 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -38,79 +38,9 @@ Learn more: See [AGENTS.md](AGENTS.md) for the full behavioral contract.
38
38
39
39
## For End Users
40
40
41
-
### Prerequisites
42
-
43
-
Before installing, ensure your environment meets the following requirements:
44
-
45
-
-**Hermes CLI** — Required to install the skill. The `post-write.js` hook is an optional safety net.
46
-
-**Node.js (v18+)** — The linting pipeline relies on native Node.js scripts and `npx` to dynamically fetch `markdownlint-cli2` without requiring global installations.
47
-
-**Cross-Platform** — The pipeline runs natively on Linux, macOS, and Windows. No WSL or Git Bash required!
The `--force` flag is required because the security scanner flags post-write hooks as dangerous (expected for a linting skill).
56
-
57
-
### Post-Install: Hook (Optional Safety Net)
58
-
59
-
The skill already instructs the AI agent to automatically lint every markdown file it writes. For guaranteed enforcement even if the agent skips the instruction, you can add a system-level hook:
- Replaced `jq` dependency with zero-dependency Node.js extraction in `post-write.js`.
257
-
- Replaced brittle bash regex `check-fences.sh` with a native `check-fences.js` script.
258
-
- Significantly improved `lint.js` bulk execution performance (node processes run once instead of per-file).
259
-
- **Refactored entirely to pure Node.js**: Replaced `lint.sh` and `post-write.sh` bash wrappers with native `.js` scripts. The pipeline is now 100% cross-platform (Windows native) and immune to `chmod +x` permission denied errors.
260
-
- **Single-pass table formatting**: Merged `fix-tables.js` + `pad-tables.js` into `format-tables.js` — halves I/O per file.
261
-
262
-
### Key Changes in v2.8
263
-
264
-
- Add `--fences` mode to `lint.js` for fenced code block validation
265
-
- Add `scripts/check-fences.js` — validates code fences natively in Node.js
266
-
- Disable MD055 (table-pipe-style) — no longer enforces leading/trailing `|` on tables
267
-
- Disable MD033 (no-inline-html) — inline HTML is allowed in GFM
268
-
- Sync `skills/markdown-lint/lint.js` with root `lint.js` (all flags now available)
269
-
270
-
### Key Changes in v2.7
271
-
272
-
- Add `--validate` mode to `format-tables.js` and `lint.js` to catch table column mismatches
273
-
- Add "Preventing Broken Tables" section with escaped pipe guidance
274
-
275
-
### Key Changes in v2.6
276
-
277
-
- Add Node.js hook `scripts/post-write.js` for auto-lint on write_file
278
-
- Add to `~/.hermes/config.yaml` to enable auto-lint
279
-
- Enable MD032 (blanks-around-lists) — lists must be surrounded by blank lines
280
-
- Enable MD060 (table-column-style) — table pipes must align with header content
281
-
- Add `hooks_auto_accept: true` for silent auto-lint on write
282
-
283
-
### Key Changes in v2.5
284
-
285
-
- Disable MD040 (fenced-code-language) and MD055 (table-pipe-style) — too strict for prose
286
-
- Fix column alignment to match VSCode/marktext format (header.length - 1)
287
-
- Remove glob dependency, use recursive fs.walk instead
0 commit comments