Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: Lint documentation

on:
push:
branches:
- main
pull_request:
branches:
- main
workflow_dispatch:

jobs:
setup:
runs-on: ubuntu-24.04
steps:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
- uses: jdx/mise-action@5083fe46898c414b2475087cc79da59e7da859e8 # v2.1.11
- uses: actions/cache@5a3ec84eff668545956fd18022155c47e93e2684 # v4.2.3
id: cache-node-modules
with:
path: docs/node_modules
key: ${{ runner.os }}-docs-${{ hashFiles('docs/package-lock.json') }}
- working-directory: docs/
run: npm ci

textlint:
needs: setup
runs-on: ubuntu-24.04
steps:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
- uses: jdx/mise-action@5083fe46898c414b2475087cc79da59e7da859e8 # v2.1.11
- uses: actions/cache@5a3ec84eff668545956fd18022155c47e93e2684 # v4.2.3
id: cache-node-modules
with:
path: docs/node_modules
key: ${{ runner.os }}-docs-${{ hashFiles('docs/package-lock.json') }}
- working-directory: docs/
run: npm run textlint
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

![integration-tests](https://github.com/textlint/vscode-textlint/actions/workflows/integration-tests.yaml/badge.svg)

Extension to integrate [textlint](https://textlint.github.io/) into VSCode.
Extension to integrate [textlint](https://textlint.github.io/) into VS Code.

## How to install

Expand Down
1 change: 1 addition & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
node_modules/
18 changes: 18 additions & 0 deletions docs/.textlintrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"plugins": {},
"filters": {
"comments": true
},
"rules": {
"prh": {
"rulePaths": ["./prh.yaml"]
},
"rousseau": {
"showLevels": ["warning", "error"],
"ignoreTypes": ["sentence:uppercase", "passive", "weasel", "readibility"]
},
"unexpanded-acronym": {
"ignore_acronyms": ["SCG", "CLI", "XML", "YAML", "JSON", "TODO", "API", "HTML", "MIT", "FAQ", "VIEW"]
}
}
}
1 change: 1 addition & 0 deletions docs/README_EXTENSION.md
1 change: 1 addition & 0 deletions docs/README_ROOT.md
Loading