https://github.com/mermade/mdv
Markdown (link/image) validator
https://github.com/mermade/mdv
a11y accessibility href link markdown validation validator
Last synced: 9 months ago
JSON representation
Markdown (link/image) validator
- Host: GitHub
- URL: https://github.com/mermade/mdv
- Owner: Mermade
- License: bsd-3-clause
- Created: 2017-03-11T10:55:03.000Z (over 9 years ago)
- Default Branch: main
- Last Pushed: 2023-11-02T16:38:12.000Z (over 2 years ago)
- Last Synced: 2025-06-13T14:58:46.994Z (about 1 year ago)
- Topics: a11y, accessibility, href, link, markdown, validation, validator
- Language: JavaScript
- Homepage:
- Size: 303 KB
- Stars: 6
- Watchers: 2
- Forks: 4
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# mdv
[](https://travis-ci.org/Mermade/mdv)
A tiny markdown validator. It understands [GFM auto-links](https://gist.github.com/asabaylus/3071099), and returns an exitCode of 1 if any rules are violated, making it suitable for use in CI environments. It is in use by the [OpenAPI Specification](https://github.com/OAI/OpenAPI-Specification), the [RAML Specification](https://github.com/raml-org/raml-spec) and the [AsyncAPI Specification](https://github.com/asyncapi/asyncapi), amongst others.
## Errors
* Undefined internal link targets - `missingAnchors[]`
* Duplicated internal link targets - `duplicatedAnchors[]`
* Anchors containing the # character - `anchorsWithHash[]`
* Links with empty text - `anchorsWithEmptyText[]`
* Local Refs without # character - `localRefNoHash[]`
* Images without an `alt` tag - `imagesWithMissingAlt[]`
* `yaml`, `json`, `xml` or `abnf` examples which do not parse - `nonParsingExamples[]`
## Warnings
* Internal manually-defined anchors with no links pointing to them
* Code-blocks with no language specified - `codeBlocksWithNoLanguage`
* Four or more leading backticks at the beginning of a line
## Usage
```
Options:
-d, --debug enable debug mode [boolean]
-s, --save save intermediary html [boolean]
-w, --warnings enable warnings [boolean]
-h, --help Show help [boolean]
```
### API
```javascript
const mdv = require('mdv');
const options = {};
const result = mdv.validate(markdownString,options);
```
### Example output
```javascript
{ imagesWithMissingAlt: 0,
source: '../openapi-specification/versions/2.0.md',
missingAnchors:
[ { name: 'dataTypeType', defined: 0, seen: 1 },
{ name: 'stType', defined: 0, seen: 2 },
{ name: 'securityDefinitions', defined: 0, seen: 1 } ],
duplicatedAnchors:
[ { name: 'itemsMaximum', defined: 2, seen: 0, auto: false },
{ name: 'headerMaximum', defined: 2, seen: 0, auto: false } ],
anchorsWithHash: [],
anchorsWithEmptyText: [],
codeBlocksWithNoLanguage: 1 }
```