Skip to content

Commit 0f20cd9

Browse files
authored
docs: add docs about lint javascript inside html (#206)
* docs: add README - lint javascript inside HTML * add docs html
1 parent fb820ec commit 0f20cd9

File tree

2 files changed

+46
-6
lines changed

2 files changed

+46
-6
lines changed

README.md

+4
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,10 @@
3737
1. [Playground](https://html-eslint.org/playground)
3838
1. [License](#License)
3939

40+
## Lint JavaScript inside HTML
41+
42+
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).
43+
4044
## License
4145

4246
Distributed under the MIT License. See [LICENSE](./LICENSE) for more information.
+42-6
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<div class="flex flex-col w-full text-left justify-center md:text-center items-center">
2-
<section class="pt-[24px] md:pt-[150px] pb-[100px] md:pb-[120px] md:max-w-[1200px] flex flex-col items-center">
2+
<section class="pt-[24px] md:pt-[150px] pb-[100px] md:pb-[80px] md:max-w-[1200px] flex flex-col items-center">
33
<h1 class="display1 md:text-[60px] md:leading-[68px] md:font-bold">
44
An <span class="text-accent">ESLint</span>
55
<br class="md:hidden">
@@ -10,18 +10,54 @@ <h1 class="display1 md:text-[60px] md:leading-[68px] md:font-bold">
1010
ESLint is a popular linting tool, but it only supports JavaScript.<br>
1111
This plugin allows you to lint your HTML code without having to install a separate linting tool or worry about editor support.
1212
</p>
13-
<ul class="[&>li]:py-1 flex md:justify-center gap-[12px] md:gap-[20px]">
13+
<ul class="[&>li]:py-1 [&>li]: w-full flex items-center flex-col md:flex-row md:justify-center gap-[12px] md:gap-[20px]">
1414
<li>
15-
<a href="~/src/docs/getting-started.html" class="bg-black-900 px-[20px] py-[10px] text-white rounded-[12px]">Getting Started</a>
15+
<h2>
16+
<a href="~/src/docs/getting-started.html" class="bg-black-900 px-[20px] py-[10px] text-white rounded-[12px]">
17+
Getting Started
18+
</a>
19+
</h2>
1620
</li>
1721
<li>
18-
<a href="~/src/playground.html" class="bg-white border border-gray-400 px-[20px] py-[10px] text-gray-900 rounded-[12px]">Playground</a>
22+
<h2>
23+
<a href="~/src/playground.html" class="bg-white border border-gray-400 px-[20px] py-[10px] text-gray-900 rounded-[12px]">
24+
Playground
25+
</a>
26+
</h2>
27+
</li>
28+
<li>
29+
<h2>
30+
<a href="~/src/docs/rules.html" class="bg-white border border-gray-400 px-[20px] py-[10px] text-gray-900 rounded-[12px]">
31+
All Rules
32+
</a>
33+
</h2>
34+
1935
</li>
2036
</ul>
2137
<img src="~/src/assets/example.png" alt="" class="border-[1px] border-gray-300 rounded-[12px] md:rounded-[28px] p-[4px] md:max-w-[1028px] mt-[36px] md:mt-[60px]" width="1028" height="260">
22-
<p class="text-center text-black-700 body3 mt-[36px] md:mt-[80px]">
38+
<div class="py-4">
39+
<h2 class="py-4 text-[20px]">FAQ</h2>
40+
<ul class="my-2 max-w-[600px] text-left">
41+
<li>
42+
<h3 class="font-semibold">Q: Lint JavaScript inside HTML</h3>
43+
<p>
44+
A: 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 <a
45+
href="https://github.com/BenoitZugmeyer/eslint-plugin-html"
46+
target="_blank"
47+
rel="noopener noreferrer"
48+
class="underline"
49+
>eslint-plugin-html</a>
50+
</p>
51+
</li>
52+
</ul>
53+
</div>
54+
<p class="text-center text-black-700 body3 mt-[80px]">
2355
If you find this project useful, <br>
24-
Please support this project with a <a href="https://github.com/yeonjuan/html-eslint" target="_blank" rel="noreferrer noopener">Github Star!</a>
56+
Please support this project with a <a
57+
href="https://github.com/yeonjuan/html-eslint"
58+
target="_blank"
59+
rel="noreferrer noopener"
60+
>Github Star!</a>
2561
</p>
2662
</section>
2763
</div>

0 commit comments

Comments
 (0)