Author high-quality Markdown documentation with deterministic structure, lint compliance, and CI integration. Use when writing README files, creating docs pages, fixing markdownlint failures, defining style rules, or wiring markdown checks into pre-commit and pipelines. Keywords: markdown, markdownlint, readme, docs, headings, lists, code fences, links, images, lint config, ci, documentation style.
95
92%
Does it follow best practices?
Impact
97%
1.00xAverage score across 7 eval scenarios
Passed
No findings from the security scan
An engineering team maintains a large operations runbook. During a recent lint audit,
markdownlint flagged every code block that lacks a language tag (rule MD040). The
file has seven code blocks; none have language tags.
Here is the input document (runbook.md):
# Database Maintenance Runbook
## Backup Procedure
Run the following script to create a backup:
```
#!/usr/bin/env bash
set -euo pipefail
pg_dump mydb > backup_$(date +%Y%m%d).sql
```
Verify the backup file exists:
```
ls -lh backup_*.sql
```
## Restore Procedure
To restore from a backup:
```
psql mydb < backup_20240301.sql
```
## Configuration
The maintenance window is controlled by this config block:
```
[maintenance]
window_start = "02:00"
window_end = "04:00"
timezone = "UTC"
```
## Monitoring Query
Use this SQL to check replication lag:
```
SELECT
client_addr,
sent_lsn - replay_lsn AS lag_bytes
FROM pg_stat_replication;
```
## Alert Threshold Config
Paste this into Alertmanager:
```
route:
receiver: pagerduty
group_wait: 30s
group_interval: 5m
```Produce a corrected runbook.md that:
Produce the corrected file runbook.md.