forked from Shopify/theme-check
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathTEMPLATE.md.erb
52 lines (33 loc) · 1.16 KB
/
TEMPLATE.md.erb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
# Check Title (`<%= class_name %>`)
_Version THEME_CHECK_VERSION+_
A short description of what the check does.
A brief paragraph explaining why the check exists (what best practice is it enforcing, and why is it important?).
## Examples
The following examples contain code snippets that either fail or pass this check.
### ✗ Fail
```liquid
```
### ✓ Pass
```liquid
```
## Options
The following example contains the default configuration for this check:
```yaml
<%= class_name %>:
enabled: false
severity: suggestion
other_option: 10_000
```
| Parameter | Description |
| --- | --- |
| enabled | Whether the check is enabled. |
| severity | The [severity](https://shopify.dev/themes/tools/theme-check/configuration#check-severity) of the check. |
| other_option | A description of the option. |
## Disabling this check
[ This check is safe to disable. You might want to disable this check if ... | Disabling this check isn't recommended because ... ].
[ This check is disabled by default when <condition>. ]
## Resources
- [Rule source][codesource]
- [Documentation source][docsource]
[codesource]: /<%= code_source %>
[docsource]: /<%= doc_source %>