borghei/Claude-Skills / markdown-html/md-review
md-review
VerifiedPre-publication quality gate for authored Markdown — heading structure, on-disk link resolution, readability, accessibility, terminology. Use when reviewing docs before publishing, wiring a docs CI gate, or auditing a Markdown corpus.
| File | Kind | Size |
|---|---|---|
| SKILL.md | skill md | 17.1 KB |
| assets/review_report_template.md | markdown | 4.3 KB |
| assets/sample_article.md | markdown | 2.4 KB |
| assets/sample_article_clean.md | markdown | 1.8 KB |
| assets/sample_review_config.json | config | 2.4 KB |
| references/readability-accessibility-and-terminology.md | markdown | 17.7 KB |
| references/review-rulebook-and-severity-model.md | markdown | 20.5 KB |
| scripts/link_checker.py | script | 11.9 KB |
| scripts/md_review_gate.py | script | 15.8 KB |
| scripts/readability_scorer.py | script | 14.1 KB |
assets/sample_review_config.json
View on GitHub{
"profile_name": "docs-site-default",
"description": "Default pre-publication review profile for technical documentation authored in Markdown and converted to HTML.",
"frontmatter": {
"required_fields": ["title", "description", "author", "date", "tags"],
"field_types": {
"title": "string",
"description": "string",
"author": "string",
"date": "date",
"tags": "list"
},
"max_lengths": {
"title": 60,
"description": 160
}
},
"structure": {
"require_single_h1": true,
"require_h1_first": true,
"allow_skipped_levels": false,
"max_heading_depth": 4,
"max_section_words": 400,
"min_section_words": 15,
"heading_case": "sentence",
"max_consecutive_headings": 2
},
"accessibility": {
"min_alt_text_chars": 10,
"max_alt_text_chars": 150,
"placeholder_alt_text": [
"image",
"img",
"photo",
"picture",
"screenshot",
"graphic",
"figure",
"alt",
"alt text",
"todo",
"tbd",
"diagram"
],
"non_descriptive_link_text": [
"click here",
"here",
"read more",
"more",
"this link",
"link",
"this",
"learn more",
"see more",
"download"
],
"require_table_headers": true,
"flag_bare_urls_as_link_text": true
},
"readability": {
"audience": "general-technical",
"target_flesch_min": 50.0,
"target_flesch_max": 70.0,
"max_grade_level": 12.0,
"long_sentence_words": 30,
"very_long_sentence_words": 45,
"max_long_sentence_pct": 10.0,
"max_passive_pct": 15.0
},
"terminology": {
"front-end": ["frontend", "front end"],
"back-end": ["backend", "back end"],
"email": ["e-mail", "E-Mail"],
"website": ["web site", "web-site"],
"sign in": ["signin", "log in", "login to"],
"open source": ["opensource", "open-source software"],
"JavaScript": ["Javascript", "javascript", "JS script"],
"GitHub": ["Github", "github.com repository"],
"internet": ["Internet"],
"setup": ["set-up"]
},
"severity_overrides": {
"structure.heading-case-inconsistent": "warning",
"readability.grade-level-high": "warning",
"terminology.disallowed-term": "warning",
"structure.section-too-long": "info"
},
"gate": {
"fail_on": "error",
"max_errors": 0,
"max_warnings": 25
}
}
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| rea-analysis-optimizationmorluto/reaOptimize REA providers and shared analysis workflows for agent context, latency, CPU, and memory while preserving correctness and Evidence. Use for analysis bottlenecks and cache or query design; CI/test-suite optimization belongs to rea-ci-tests-audit. | Stars: 472k | Updated | Claude CodeCodex | Verified | Install |
| rea-ci-tests-auditmorluto/reaAudit REA CI and test suites for correctness, fixture drift, false passes, and measured performance; use for suite or workflow investigations and efficiency changes, rather than ordinary feature testing or a single test failure. | Stars: 472k | Updated | Claude CodeCodex | Verified | Install |
| rea-tool-designmorluto/reaAudit, investigate, design, or change REA investigation tools, CLI/MCP contracts, provider capabilities, and Evidence semantics. | Stars: 472k | Updated | Claude CodeCodex | Verified | Install |
| ponytail-auditDietrichGebert/ponytailQuality audit of the whole repo: bugs, security, real load, missing tests, speed, and what to delete. Most important first. | Stars: 194k | Updated | Claude CodeCodex | Verified | Install |