2022-10-30 15:13:19 -07:00
|
|
|
# `MD033` - Inline HTML
|
2022-10-29 23:21:45 -07:00
|
|
|
|
2022-10-30 15:13:19 -07:00
|
|
|
Tags: `html`
|
2022-10-29 23:21:45 -07:00
|
|
|
|
2022-10-30 15:13:19 -07:00
|
|
|
Aliases: `no-inline-html`
|
2022-10-29 23:21:45 -07:00
|
|
|
|
|
|
|
|
Parameters:
|
|
|
|
|
|
2022-11-13 20:53:10 -08:00
|
|
|
- `allowed_elements`: Allowed elements (`string[]`, default `[]`)
|
2022-10-29 23:21:45 -07:00
|
|
|
|
|
|
|
|
This rule is triggered whenever raw HTML is used in a Markdown document:
|
|
|
|
|
|
|
|
|
|
```markdown
|
|
|
|
|
<h1>Inline HTML heading</h1>
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
To fix this, use 'pure' Markdown instead of including raw HTML:
|
|
|
|
|
|
|
|
|
|
```markdown
|
|
|
|
|
# Markdown heading
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Note: To allow specific HTML elements, use the `allowed_elements` parameter.
|
|
|
|
|
|
|
|
|
|
Rationale: Raw HTML is allowed in Markdown, but this rule is included for
|
|
|
|
|
those who want their documents to only include "pure" Markdown, or for those
|
|
|
|
|
who are rendering Markdown documents into something other than HTML.
|
