diff --git a/.github/workflows/spellcheck.yml b/.github/workflows/spellcheck.yml new file mode 100644 index 000000000..96fc61088 --- /dev/null +++ b/.github/workflows/spellcheck.yml @@ -0,0 +1,18 @@ +name: Typo CI + +on: + pull_request: + push: + branches: + - main +jobs: + spellcheck: + name: Typo CI (GitHub Action) + runs-on: ubuntu-latest + timeout-minutes: 4 + if: "!contains(github.event.head_commit.message, '[ci skip]')" + steps: + - name: TypoCheck + uses: typoci/spellcheck-action@master + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/.husky/pre-commit b/.husky/pre-commit index d24fdfc60..7a6c2882b 100755 --- a/.husky/pre-commit +++ b/.husky/pre-commit @@ -2,3 +2,5 @@ . "$(dirname -- "$0")/_/husky.sh" npx lint-staged + +typos docs diff --git a/README.md b/README.md index 5c755765a..8cff119d6 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,14 @@ This website is built using [Docusaurus 2](https://docusaurus.io/), a modern sta npm ci ``` +```shell +curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh +``` + +``` +cargo install typos-cli +``` + ### Local Development ```shell