Skip to content

Commit

Permalink
Add syntax highlighting for readability (#64)
Browse files Browse the repository at this point in the history
  • Loading branch information
hugovk authored Apr 28, 2023
1 parent 57beb9f commit 94259cd
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Any warnings or errors will be annotated in the Pull Request.

## Usage

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

```
```yml
uses: codespell-project/actions-codespell@v1
with:
only_warn: 1
Expand Down

0 comments on commit 94259cd

Please sign in to comment.