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
A contributor submitted a documentation file with several markdownlint violations. The violations must be fixed in the source content. Disabling rules globally or adding broad suppressions is not acceptable.
Here is the input document (guide.md):
# Getting Started
### Installation
Run the following to install:
```
npm install my-tool
```
Then configure it:
```
# config.yaml
host: localhost
port: 8080
```
## Usage
- Use the `--verbose` flag for detailed output
* Use the `--dry-run` flag to preview changes
+ Use `--help` to see all options
#### Advanced Options
For power users, the following options are available:
| Option | Description |
|--------|-------------|
|`--timeout` | Sets the request timeout |
| `--retries`| Number of retries |Produce a corrected file guide.md that:
Produce a single file guide.md with all violations corrected.