From 0f20cd95ee5264bf282f30bfe3f51a49964bfeee Mon Sep 17 00:00:00 2001 From: YeonJuan Date: Sat, 3 Aug 2024 22:20:18 +0900 Subject: [PATCH] docs: add docs about lint javascript inside html (#206) * docs: add README - lint javascript inside HTML * add docs html --- README.md | 4 ++ packages/website/src/components/home.html | 48 ++++++++++++++++++++--- 2 files changed, 46 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 3e1aa816..a5a37e8d 100644 --- a/README.md +++ b/README.md @@ -37,6 +37,10 @@ 1. [Playground](https://html-eslint.org/playground) 1. [License](#License) +## Lint JavaScript inside HTML + +This ESLint plugin supports linting HTML syntax and does not provide JavaScript syntax linting. To lint JavaScript in HTML, such as inline scripts, you can use [eslint-plugin-html](https://github.com/BenoitZugmeyer/eslint-plugin-html). + ## License Distributed under the MIT License. See [LICENSE](./LICENSE) for more information. diff --git a/packages/website/src/components/home.html b/packages/website/src/components/home.html index 1f8c339a..870389eb 100644 --- a/packages/website/src/components/home.html +++ b/packages/website/src/components/home.html @@ -1,5 +1,5 @@
-
+

An ESLint
@@ -10,18 +10,54 @@

ESLint is a popular linting tool, but it only supports JavaScript.
This plugin allows you to lint your HTML code without having to install a separate linting tool or worry about editor support.

-