/html-validate-markdown

Transform plugin for https://html-validate.org

Primary LanguageTypeScript

html-validate-markdown

Transform Html blocks in Markdown files for use with html-validate.

Build npm

<div>
    This is a html block. View Source to see me. Remember to always add ```html
    before your code in order to transform it.
</div>

Usage

npm install --save-dev html-validate-markdown

In .htmlvalidate.json:

{
    "transform": {
        "^.*\\.md$": "html-validate-markdown"
    }
}

If you wish to ignore a code fence from validation use the novalidate tag:

```html novalidate
<p>This will not be validated</i>
```

Configuration

By default only html code fences are validated but additional languages can be added by chaining additional transformers:

In .htmlvalidate.json:

{
  "transform": {
    "^.*\\.md$": "html-validate-markdown"
    "^.*\\.md:vue$": "html-validate-vue:sfc"
  }
}

In this case any code fence with the language vue will be transformed with html-validate-vue before validation.

If needed, html can be configured the same way using a regex similar to ^.*\\.md:html.

Development

$ npm install
$ npm run build
$ npm test

Copied from https://gitlab.com/html-validate/html-validate-vue