Commit 1a896a87 authored by David Sveningsson's avatar David Sveningsson

fix(rules): improve documentation for `doctype-html`

parent 8b106014
......@@ -2,7 +2,11 @@
exports[`rule doctype-html should contain documentation 1`] = `
Object {
"description": "HTML5 documents should use the \\"html\\" doctype (short form, not legacy string)",
"description": "HTML5 documents should use the \\"html\\" doctype (short \`form\`, not legacy string):
\`\`\`html
<!DOCTYPE html>
\`\`\`",
"url": "https://html-validate.org/rules/doctype-html.html",
}
`;
......@@ -4,8 +4,13 @@ import { Rule, RuleDocumentation, ruleDocumentationUrl } from "../rule";
class NoStyleTag extends Rule {
public documentation(): RuleDocumentation {
return {
description:
'HTML5 documents should use the "html" doctype (short form, not legacy string)',
description: [
'HTML5 documents should use the "html" doctype (short `form`, not legacy string):',
"",
"```html",
"<!DOCTYPE html>",
"```",
].join("\n"),
url: ruleDocumentationUrl(__filename),
};
}
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment