Sha256: 2088ddd50af328db49b79fcabd0b5a33831a1e9ac80da49a70cc29f6b923154b

Contents?: true

Size: 1.16 KB

Versions: 7

Compression:

Stored size: 1.16 KB

Contents

# 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.

### &#x2717; Fail

```liquid
```

### &#x2713; 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 %>

Version data entries

7 entries across 7 versions & 1 rubygems

Version Path
theme-check-1.15.0 docs/checks/TEMPLATE.md.erb
theme-check-1.14.0 docs/checks/TEMPLATE.md.erb
theme-check-1.13.0 docs/checks/TEMPLATE.md.erb
theme-check-1.12.1 docs/checks/TEMPLATE.md.erb
theme-check-1.12.0 docs/checks/TEMPLATE.md.erb
theme-check-1.11.0 docs/checks/TEMPLATE.md.erb
theme-check-1.10.3 docs/checks/TEMPLATE.md.erb