Skip to content

Commit a93ded7

Browse files
authored
docs: add faq page (#302)
* docs: add faq page * Update .cspell.json
1 parent cd7f829 commit a93ded7

File tree

5 files changed

+51
-1
lines changed

5 files changed

+51
-1
lines changed

.cspell.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
"packages/eslint-plugin/types/**"
1414
],
1515
"words": [
16+
"tseslint",
1617
"frontmatter",
1718
"rehype",
1819
"tailwindcss",

docs/faq.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# FAQs
2+
3+
## Problem when using typescript-eslint typed linting.
4+
5+
```
6+
Error: Error while loading rule '@typescript-eslint/await-thenable': You have used a rule which requires type information, but don't have parserOptions set to generate type information for this file....
7+
Parser: @html-eslint/parser
8+
```
9+
10+
When using [typescript-eslint Typed-Linting](https://typescript-eslint.io/troubleshooting/typed-linting), the above error may occur for HTML files. In this case, disable typed-linting rules for HTML.
11+
12+
```js
13+
export default tseslint.config(
14+
//...,
15+
{
16+
files: ["**/*.html"],
17+
extends: [tseslint.configs.disableTypeChecked],
18+
}
19+
// ...
20+
);
21+
```
Lines changed: 1 addition & 0 deletions
Loading

packages/website/src/components/footer.html

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,16 @@
1414
<a
1515
href="~/src/privacy-policy.html"
1616
target="_blank noreferrer"
17-
class="text-slate-600 pl-2"
17+
class="text-slate-600 border-r border-black-500 pl-2 pr-2"
1818
>Privacy Policy</a>
1919
</li>
20+
<li>
21+
<a
22+
href="~/src/docs/faq.html"
23+
target="_blank noreferrer"
24+
class="text-slate-600 pl-2"
25+
>FAQs</a>
26+
</li>
2027
</ul>
2128
<span class="text-black-500">Copyright © 2025 html-eslint</span>
2229
</div>

packages/website/src/components/nav.html

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,26 @@
9191
>
9292
</a>
9393
</li>
94+
<li>
95+
<a href="~/src/docs/faq.html" class="w-full flex items-center">
96+
<div class="w-[28px] h-[28px] rounded-[6px] p-[6px] border-[1px] border-gray-300 drop-shadow-[4px_0_2px_#E8EBEF] mr-[12px]">
97+
<img
98+
src="~/src/assets/icon-question.svg"
99+
alt=""
100+
width="14"
101+
height="14"
102+
>
103+
</div>
104+
<span class="title5">FAQs</span>
105+
<img
106+
src="~/src/assets/icon-chevron-right.svg"
107+
alt=""
108+
class="ml-auto"
109+
width="20"
110+
height="20"
111+
>
112+
</a>
113+
</li>
94114
<li>
95115
<a href="~/src/docs/rules.html" class="w-full flex items-center">
96116
<div class="w-[28px] h-[28px] rounded-[6px] p-[6px] border-[1px] border-gray-300 drop-shadow-[4px_0_2px_#E8EBEF] mr-[12px]">

0 commit comments

Comments
 (0)