aboutsummaryrefslogtreecommitdiffhomepage
path: root/src
diff options
context:
space:
mode:
authorYasutake Yohei <yohei@yasutakeyohei.com>2026-07-01 22:42:59 +0900
committerYasutake Yohei <yohei@yasutakeyohei.com>2026-07-01 22:42:59 +0900
commit9d661591690871c6d6668af30cf7d9bd47a85c88 (patch)
tree10d8bb848bd51cf382b834c38b461f4060dcca78 /src
parent4325608150bad29d190154699255a76d85ebe219 (diff)
textlint-guide: 導入方法を更新、拡張機能zipを追加
Diffstat (limited to 'src')
-rw-r--r--src/content/docs/textlint-guide.mdx53
1 files changed, 33 insertions, 20 deletions
diff --git a/src/content/docs/textlint-guide.mdx b/src/content/docs/textlint-guide.mdx
index 6059dc8..b33f5cb 100644
--- a/src/content/docs/textlint-guide.mdx
+++ b/src/content/docs/textlint-guide.mdx
@@ -10,32 +10,37 @@ draft: true
## 2つのプログラム
-| 名前 | 役割 | 公開 |
+| 名前 | 役割 | 公開予定 |
|---|---|---|
-| `textlint-lsp` | LSPサーバー本体。Node.jsで動作。Zed以外のエディタでも使える | npm(準備中) |
-| `zed-textlint` | Zed拡張機能。Zed上で `textlint-lsp` を起動する | 開発中 |
+| `textlint-lsp` | LSPサーバー本体。Node.jsで動作。どのエディタでも使える | npm に公開予定 |
+| `zed-textlint` | Zed拡張機能。`textlint-lsp` を起動する | [zed-industries/extensions](https://github.com/zed-industries/extensions) にPR予定 |
LSPサーバーは汎用なので、VSCodeやNeovimなどほかのエディタでも動きます。
## できること
-- 保存時に自動校正(編集を止めて10秒後にも自動実行)
+- 文字入力のたびに自動校正(結果はキャッシュされるので高速)
- 波線で問題箇所を表示
-- 修正候補の適用(`Ctrl+.`)
-- ルール単位の無効化
+- `Ctrl+.` で修正候補を表示・適用
+- ルール単位の無効化(行単位/全ルール)
- `prh.yml` による独自の表記ルール定義
-## セットアップ
+## 導入方法
-1. Node.js 18以上をインストール
-2. プロジェクトにtextlintとルールを追加
+### 1. textlint-lsp をインストール
+
+```bash
+npm install -g textlint-lsp
+```
+
+### 2. プロジェクトにtextlintをセットアップ
```bash
npm install --save-dev textlint @textlint/markdown
npm install --save-dev @textlint-ja/no-synonyms prh
```
-3. `.textlintrc.json` を作成
+`.textlintrc.json` を作成:
```json
{
@@ -47,15 +52,13 @@ npm install --save-dev @textlint-ja/no-synonyms prh
}
```
-4. `prh.yml` に独自ルールを定義
+### 3. Zed拡張機能をインストール
-```yaml
-version: 1
-rules:
- - expected: たとえば
- pattern: 例えば
- prh: 漢字で書かず、ひらがなで書くと読みやすくなります
-```
+1. [zed-textlint.zip](/zed-textlint.zip) をダウンロードして展開
+2. Zedで `Ctrl+Shift+P` → `zed: install dev extension` を実行
+3. 展開した `zed-textlint` フォルダを指定
+
+導入後、`.md` または `.mdx` ファイルを開くと自動的にlintが走ります。
## コードアクション(自動修正)
@@ -84,12 +87,22 @@ rules:
Zedのコードアクションから自動挿入されるので、普段は手動で書く必要はありません。
:::
+## 公開について
+
+### `textlint-lsp`(LSPサーバー)
+
+npmで公開済みです。`npm install -g textlint-lsp` でインストール可能です。
+
+### `zed-textlint`(Zed拡張機能)
+
+[zed-textlint.zip](/zed-textlint.zip) をダウンロードし、Zedの Dev Extension としてインストールしてください。
+
## トラブルシューティング
### MDXファイルで `{ }` がエラーになる
Mermaid図の `{{ }}` がMDXパーサにJSX式と誤認されることがあります。`{{` を `(` に置き換えてください。
-### lintが重い
+### lintが遅い
-`textlint-lsp` は保存時と、編集を止めてから10秒後に自動実行されます。編集のたびに走ることはありません。
+初回のlintには数秒かかりますが、結果はキャッシュされるため2回目以降は高速です。