# html-validate-markdown

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

[![Build](https://github.com/OlofFredriksson/html-validate-markdown/workflows/Build/badge.svg)](https://github.com/OlofFredriksson/html-validate-markdown/actions)
[![npm](https://img.shields.io/npm/v/html-validate-markdown)](https://www.npmjs.com/package/html-validate-markdown)

````html
<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>
````

[html-validate]: https://www.npmjs.com/package/html-validate

## Usage

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

In `.htmlvalidate.json`:

```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`:

```js
{
  "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

```bash
$ npm install
$ npm run build
$ npm test
```

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