Skip to content

Docs: Add GitHub Code Scanning #1647

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 10, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion website/src/content/docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ import { Card, CardGrid } from '@astrojs/starlight/components'
Download the HTMLHint extension for Visual Studio Code to get real-time
feedback on your HTML code.
<div class="mt-1">
- [Visual Studio Code
- [VS Code
Marketplace](https://marketplace.visualstudio.com/items?itemName=HTMLHint.vscode-htmlhint)
- [Open VSX
Registry](https://open-vsx.org/extension/HTMLHint/vscode-htmlhint)
Expand Down
5 changes: 3 additions & 2 deletions website/src/content/docs/rules/attr-lowercase.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,9 @@ Level: <Badge text="Error" variant="danger" />

## Config value

1. true: enable rule
2. false: disable rule
- `true`: enable rule
- `false`: disable rule

3. ['fooBar', 'Test']: enable rule except for the given attribute names. All SVG camelCase properties are included, for example `viewBox`

### Example
Expand Down
4 changes: 2 additions & 2 deletions website/src/content/docs/rules/attr-no-duplication.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ Level: <Badge text="Error" variant="danger" />

## Config value

1. true: enable rule
2. false: disable rule
- `true`: enable rule
- `false`: disable rule

### The following patterns are **not** considered rule violations

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ Level: <Badge text="Error" variant="danger" />

## Config value

1. true: enable rule
2. false: disable rule
- `true`: enable rule
- `false`: disable rule

### The following patterns are **not** considered rule violations

Expand Down
4 changes: 2 additions & 2 deletions website/src/content/docs/rules/attr-sorted.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ Level: <Badge text="Error" variant="danger" />

## Config value

1. true: enable rule
2. false: disable rule
- `true`: enable rule
- `false`: disable rule

### The following patterns are **not** considered rule violations

Expand Down
4 changes: 2 additions & 2 deletions website/src/content/docs/rules/attr-unsafe-chars.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ Level: <Badge text="Warning" variant="caution" />

## Config value

1. true: enable rule
2. false: disable rule
- `true`: enable rule
- `false`: disable rule

### The following patterns are **not** considered rule violations

Expand Down
4 changes: 2 additions & 2 deletions website/src/content/docs/rules/attr-value-double-quotes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ Level: <Badge text="Error" variant="danger" />

## Config value

1. true: enable rule
2. false: disable rule
- `true`: enable rule
- `false`: disable rule

### The following patterns are **not** considered rule violations

Expand Down
4 changes: 2 additions & 2 deletions website/src/content/docs/rules/attr-value-not-empty.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ Level: <Badge text="Warning" variant="caution" />

## Config value

1. true: enable rule
2. false: disable rule
- `true`: enable rule
- `false`: disable rule

### The following patterns are **not** considered rule violations

Expand Down
4 changes: 2 additions & 2 deletions website/src/content/docs/rules/attr-value-single-quotes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ Level: <Badge text="Error" variant="danger" />

## Config value

1. true: enable rule
2. false: disable rule
- `true`: enable rule
- `false`: disable rule

### The following patterns are **not** considered rule violations

Expand Down
4 changes: 2 additions & 2 deletions website/src/content/docs/rules/attr-whitespace.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ Level: <Badge text="Error" variant="danger" />

## Config value

1. true: enable rule
2. false: disable rule
- `true`: enable rule
- `false`: disable rule

### The following patterns are **not** considered rule violations

Expand Down
4 changes: 2 additions & 2 deletions website/src/content/docs/rules/doctype-first.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ Level: <Badge text="Error" variant="danger" />

## Config value

1. true: enable rule
2. false: disable rule
- `true`: enable rule
- `false`: disable rule

### The following patterns are **not** considered rule violations

Expand Down
4 changes: 2 additions & 2 deletions website/src/content/docs/rules/doctype-html5.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ Level: <Badge text="Warning" variant="caution" />

## Config value

1. true: enable rule
2. false: disable rule
- `true`: enable rule
- `false`: disable rule

### The following pattern is **not** considered a rule violations

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ Level: <Badge text="Warning" variant="caution" />

## Config value

1. true: enable rule
2. false: disable rule
- `true`: enable rule
- `false`: disable rule

### The following patterns are **not** considered rule violations

Expand Down
4 changes: 2 additions & 2 deletions website/src/content/docs/rules/h1-require.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ Level: <Badge text="Warning" variant="caution" />

## Config value

1. true: enable rule
2. false: disable rule
- `true`: enable rule
- `false`: disable rule

### The following patterns are **not** considered rule violations

Expand Down
4 changes: 2 additions & 2 deletions website/src/content/docs/rules/head-script-disabled.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ Level: <Badge text="Warning" variant="caution" />

## Config value

1. true: enable rule
2. false: disable rule
- `true`: enable rule
- `false`: disable rule

### The following patterns are **not** considered rule violations

Expand Down
6 changes: 3 additions & 3 deletions website/src/content/docs/rules/href-abs-or-rel.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ Level: <Badge text="Warning" variant="caution" />

## Config value

1. abs: absolute mode
2. rel: relative mode
3. false: disable rule
- `abs`: absolute mode
- `rel`: relative mode
- `false`: disable rule

### The following patterns are **not** considered rule violations

Expand Down
4 changes: 2 additions & 2 deletions website/src/content/docs/rules/html-lang-require.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ Level: <Badge text="Warning" variant="caution" />

## Config value

1. true: enable rule
2. false: disable rule
- `true`: enable rule
- `false`: disable rule

### The following pattern is **not** considered rule violations

Expand Down
4 changes: 2 additions & 2 deletions website/src/content/docs/rules/id-class-ad-disabled.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ Level: <Badge text="Warning" variant="caution" />

## Config value

1. true: enable rule
2. false: disable rule
- `true`: enable rule
- `false`: disable rule

### The following patterns are **not** considered rule violations

Expand Down
8 changes: 4 additions & 4 deletions website/src/content/docs/rules/id-class-value.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@ Level: <Badge text="Warning" variant="caution" />

## Config value

1. underline: underline mode ( aaa_bb )
2. dash: enable rule ( aaa-bbb )
3. hump: enable rule ( aaaBbb )
4. false: disable rule
- `underline`: underline mode ( aaa_bb )
- `dash`: enable rule ( aaa-bbb )
- `hump`: enable rule ( aaaBbb )
- `false`: disable rule

### The following patterns are **not** considered rule violations

Expand Down
4 changes: 2 additions & 2 deletions website/src/content/docs/rules/id-unique.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ Level: <Badge text="Error" variant="danger" />

## Config value

1. true: enable rule
2. false: disable rule
- `true`: enable rule
- `false`: disable rule

### The following patterns are **not** considered rule violations

Expand Down
4 changes: 2 additions & 2 deletions website/src/content/docs/rules/inline-script-disabled.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ Level: <Badge text="Warning" variant="caution" />

## Config value

1. true: enable rule
2. false: disable rule
- `true`: enable rule
- `false`: disable rule

### The following patterns are considered violations

Expand Down
4 changes: 2 additions & 2 deletions website/src/content/docs/rules/inline-style-disabled.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ Level: <Badge text="Warning" variant="caution" />

## Config value

1. true: enable rule
2. false: disable rule
- `true`: enable rule
- `false`: disable rule

### The following pattern is considered a rule violation:

Expand Down
4 changes: 2 additions & 2 deletions website/src/content/docs/rules/input-requires-label.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ Level: <Badge text="Warning" variant="caution" />

## Config value

1. true: enable rule
2. false: disable rule
- `true`: enable rule
- `false`: disable rule

### The following patterns are **not** considered rule violations

Expand Down
4 changes: 2 additions & 2 deletions website/src/content/docs/rules/main-require.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ Level: <Badge text="Warning" variant="caution" />

## Config value

1. true: enable rule
2. false: disable rule
- `true`: enable rule
- `false`: disable rule

### The following patterns are **not** considered rule violations

Expand Down
4 changes: 2 additions & 2 deletions website/src/content/docs/rules/meta-charset-require.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ Level: <Badge text="Error" variant="danger" />

## Config value

1. true: enable rule
2. false: disable rule
- `true`: enable rule
- `false`: disable rule

### The following patterns are **not** considered rule violations

Expand Down
4 changes: 2 additions & 2 deletions website/src/content/docs/rules/meta-description-require.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ Level: <Badge text="Error" variant="danger" />

## Config value

1. true: enable rule
2. false: disable rule
- `true`: enable rule
- `false`: disable rule

### The following patterns are **not** considered rule violations

Expand Down
4 changes: 2 additions & 2 deletions website/src/content/docs/rules/meta-viewport-require.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ Level: <Badge text="Error" variant="danger" />

## Config value

1. true: enable rule
2. false: disable rule
- `true`: enable rule
- `false`: disable rule

### The following patterns are **not** considered rule violations

Expand Down
4 changes: 2 additions & 2 deletions website/src/content/docs/rules/script-disabled.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ Level: <Badge text="Warning" variant="caution" />

## Config value

1. true: enable rule
2. false: disable rule
- `true`: enable rule
- `false`: disable rule

### The following patterns are **not** considered rule violations

Expand Down
8 changes: 4 additions & 4 deletions website/src/content/docs/rules/space-tab-mixed-disabled.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@ Level: <Badge text="Warning" variant="caution" />

## Config values

1. space: space mode (only spaces are valid for indentation)
2. space4: space mode and require 4 space characters
3. tab: tab mode (only tab characters are valid for indentation)
4. false: disable rule
- `space`: space mode (only spaces are valid for indentation)
- `space4`: space mode and require 4 space characters
- `tab`: tab mode (only tab characters are valid for indentation)
- `false`: disable rule

### Example

Expand Down
4 changes: 2 additions & 2 deletions website/src/content/docs/rules/spec-char-escape.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ Level: <Badge text="Error" variant="danger" />

## Config value

1. true: enable rule
2. false: disable rule
- `true`: enable rule
- `false`: disable rule

### The following patterns are **not** considered violations

Expand Down
4 changes: 2 additions & 2 deletions website/src/content/docs/rules/src-not-empty.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ Level: <Badge text="Error" variant="danger" />

## Config value

1. true: enable rule
2. false: disable rule
- `true`: enable rule
- `false`: disable rule

### The following patterns are **not** considered rule violations

Expand Down
4 changes: 2 additions & 2 deletions website/src/content/docs/rules/style-disabled.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ Level: <Badge text="Warning" variant="caution" />

## Config value

1. true: enable rule
2. false: disable rule
- `true`: enable rule
- `false`: disable rule

### The following patterns are considered violations

Expand Down
4 changes: 2 additions & 2 deletions website/src/content/docs/rules/tag-pair.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ Level: <Badge text="Error" variant="danger" />

## Config value

1. true: enable rule
2. false: disable rule
- `true`: enable rule
- `false`: disable rule

### The following patterns are **not** considered rule violations

Expand Down
4 changes: 2 additions & 2 deletions website/src/content/docs/rules/tag-self-close.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ Level: <Badge text="Warning" variant="caution" />

## Config value

1. true: enable rule
2. false: disable rule
- `true`: enable rule
- `false`: disable rule

### The following pattern is **not** considered a violations

Expand Down
5 changes: 3 additions & 2 deletions website/src/content/docs/rules/tagname-lowercase.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,9 @@ Level: <Badge text="Error" variant="danger" />

## Config value

1. true: enable rule
2. false: disable rule
- `true`: enable rule
- `false`: disable rule

3. ['clipPath', 'test']: Ignore some tagname name

### The following patterns are **not** considered rule violations
Expand Down
Loading