Skip to content

Commit 94259cd

Browse files
authored
Add syntax highlighting for readability (#64)
1 parent 57beb9f commit 94259cd

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

README.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Any warnings or errors will be annotated in the Pull Request.
55

66
## Usage
77

8-
```
8+
```yml
99
uses: codespell-project/actions-codespell@v1
1010
```
1111
@@ -15,7 +15,7 @@ If set, check file names for spelling mistakes as well.
1515
1616
This parameter is optional; by default `codespell` will only check the file contents.
1717

18-
```
18+
```yml
1919
uses: codespell-project/actions-codespell@v1
2020
with:
2121
check_filenames: true
@@ -27,7 +27,7 @@ If set, check hidden files (those starting with ".") for spelling mistakes as we
2727

2828
This parameter is optional; by default `codespell` will not check hidden files.
2929

30-
```
30+
```yml
3131
uses: codespell-project/actions-codespell@v1
3232
with:
3333
check_hidden: true
@@ -39,7 +39,7 @@ File with lines that should not be checked for spelling mistakes.
3939

4040
This parameter is optional; by default `codespell` will check all lines.
4141

42-
```
42+
```yml
4343
uses: codespell-project/actions-codespell@v1
4444
with:
4545
exclude_file: src/foo
@@ -51,7 +51,7 @@ Comma-separated list of files to skip (it accepts globs as well).
5151

5252
This parameter is optional; by default `codespell` won't skip any files.
5353

54-
```
54+
```yml
5555
uses: codespell-project/actions-codespell@v1
5656
with:
5757
skip: foo,bar
@@ -63,7 +63,7 @@ Comma-separated list of builtin dictionaries to use.
6363

6464
This parameter is optional; by default `codespell` will use its default selection of built in dictionaries.
6565

66-
```
66+
```yml
6767
uses: codespell-project/actions-codespell@v1
6868
with:
6969
builtin: clear,rare
@@ -76,7 +76,7 @@ Words are case sensitive based on how they are written in the dictionary file.
7676

7777
This parameter is optional; by default `codespell` will check all words for typos.
7878

79-
```
79+
```yml
8080
uses: codespell-project/actions-codespell@v1
8181
with:
8282
ignore_words_file: .codespellignore
@@ -89,7 +89,7 @@ Words are case sensitive based on how they are written in the dictionary file.
8989

9090
This parameter is optional; by default `codespell` will check all words for typos.
9191

92-
```
92+
```yml
9393
uses: codespell-project/actions-codespell@v1
9494
with:
9595
ignore_words_list: abandonned,ackward
@@ -103,7 +103,7 @@ If set to "*", all misspelling in URIs and emails will be ignored.
103103

104104
This parameter is optional; by default `codespell` will check all URIs and emails for typos.
105105

106-
```
106+
```yml
107107
uses: codespell-project/actions-codespell@v1
108108
with:
109109
uri_ignore_words_list: abandonned
@@ -116,7 +116,7 @@ This can be useful if your project has code you don't want to spell check for so
116116

117117
This parameter is optional; by default `codespell` will run on your whole repository.
118118

119-
```
119+
```yml
120120
uses: codespell-project/actions-codespell@v1
121121
with:
122122
path: src
@@ -130,7 +130,7 @@ All errors and warnings are annotated in Pull Requests, but it will act like eve
130130

131131
This parameter is optional; setting this to any value will enable it.
132132

133-
```
133+
```yml
134134
uses: codespell-project/actions-codespell@v1
135135
with:
136136
only_warn: 1

0 commit comments

Comments
 (0)