# textlint [textlint · The pluggable linting tool for text and markdown](https://textlint.github.io) ## Setup ### Installer [ダウンロード | Node.js](https://nodejs.org/ja/download) ### Install nodebrew [GitHub - hokaccha/nodebrew: Node.js version manager](https://github.com/hokaccha/nodebrew) #### Using Homebrew ```sh brew install nodebrew nodebrew setup ``` ### Terminal 1. cd /path/to/project 2. install using npm Run textlint ```sh npx textlint README.md ``` ## VSCode [vscode-textlint - Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=taichi.vscode-textlint) ## 日本語ルール [textlint-ja · GitHub](https://github.com/textlint-ja) > [textlint](https://textlint.github.io/)の日本語に関するルールを扱うコミュニティです。 ### Presets - [GitHub - textlint-ja/textlint-rule-preset-japanese: textlint rule preset for Japanese.](https://github.com/textlint-ja/textlint-rule-preset-japanese) - [GitHub - textlint-ja/textlint-rule-preset-JTF-style: JTF日本語標準スタイルガイド for textlint.](https://github.com/textlint-ja/textlint-rule-preset-JTF-style) - [GitHub - textlint-ja/textlint-rule-preset-ja-spacing: スペース周りのスタイルを扱うtextlintルール集](https://github.com/textlint-ja/textlint-rule-preset-ja-spacing) - [GitHub - textlint-ja/textlint-rule-preset-foreign-language-writing: [WIP] 外来語（カタカナ）の書き方を扱うtextlintルールプリセット](https://github.com/textlint-ja/textlint-rule-preset-foreign-language-writing) - [よりよい文書を書くための校正ツール「textlint」のSmartHR用ルールプリセットを公開しました！｜SmartHRオープン社内報｜株式会社SmartHR](https://note.com/smarthr_co/n/n881866630eda) - [textlint-rule-preset-smarthr - npm](https://www.npmjs.com/package/textlint-rule-preset-smarthr) ### Yahoo Proofreading API - [GitHub - KeitaMoromizato/textlint-rule-ja-yahoo-kousei: Yahoo校正APIを使ったtextlintルール](https://github.com/KeitaMoromizato/textlint-rule-ja-yahoo-kousei) ## Dictionary [GitHub - textlint-rule/textlint-rule-prh: textlint rule for prh.](https://github.com/textlint-rule/textlint-rule-prh) ## Ignore rules [GitHub - textlint/textlint-filter-rule-allowlist: textlint filter rule that filters any word by allowing lists.](https://github.com/textlint/textlint-filter-rule-allowlist) ## Architecture [textlint - Linterの作り方](https://azu.github.io/slide/2022/lint-night/textlint.html)