Update configurations docs #426
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Check document | |
| on: | |
| push: | |
| branches: [master] | |
| paths: | |
| - 'docs/**' | |
| - 'package.json' | |
| - '.autocorrectrc' | |
| - '.markdownlint-cli2.jsonc' | |
| - '.github/workflows/check-doc.yaml' | |
| pull_request: | |
| branches: [master] | |
| paths: | |
| - 'docs/**' | |
| - 'package.json' | |
| - '.autocorrectrc' | |
| - '.markdownlint-cli2.jsonc' | |
| - '.github/workflows/check-doc.yaml' | |
| jobs: | |
| check-doc: | |
| name: Check document | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Use Node.js | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: '18.x' | |
| cache: 'npm' | |
| - name: Install dependencies | |
| run: | | |
| npm ci | |
| - name: Lint Markdown files (markdownlint) | |
| run: | | |
| npm run markdown-lint | |
| - name: Lint Markdown files (autocorrect) | |
| uses: huacnlee/autocorrect-action@main | |
| with: | |
| args: --lint ./docs/ | |
| - name: Check broken link (including broken anchor) | |
| run: | | |
| npm run check-broken-link |