Skip to content

Commit 8b4673d

Browse files
authored
Update README.md
1 parent 277bec9 commit 8b4673d

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -174,6 +174,15 @@ We recommened to use cron job like GitHub Actions.
174174

175175
### textlint + [SARIF output](https://www.npmjs.com/package/@microsoft/eslint-formatter-sarif) + [code scanning](https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)
176176

177+
Preparing:
178+
179+
```shell
180+
# Install dependencies
181+
$ npm install --save-dev textlint @microsoft/eslint-formatter-sarif textlint-rule-no-dead-link
182+
# Create .textlintrc
183+
$ npx textlint --init
184+
```
185+
177186
Following actions check links and upload the status to [code scanning](https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning).
178187

179188
You can see the result at `https://github.com/{owner}/{repo}/security/code-scanning`.

0 commit comments

Comments
 (0)