textlint

(โ˜… 3,170)

textlint is the pluggable linter for natural language text.

  • .editorconfig
  • .gitattributes
  • .gitignore
  • .gitmodules
  • .node-version
  • .oxlintrc.json
  • .prettierignore
  • CHANGELOG.md
  • lerna.json
  • LICENSE
  • package.json
  • pnpm-lock.yaml
  • pnpm-workspace.yaml
  • README.md
  • renovate.json
  • tsconfig.base.json
  • tsconfig.json
  • vitest.config.mts

# Installation Guide

1. Get the code
git clone https://github.com/textlint/textlint

Downloads the entire project code from GitHub to your computer.

cd textlint

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
$ npm install textlint --save-dev

Downloads and installs the libraries listed in package.json.

npm install --save-dev textlint textlint-rule-no-todo

Downloads and installs the libraries listed in package.json.

- `npm install textlint-rule-xxx`.

Downloads and installs the libraries listed in package.json.

npm install textlint-plugin-html --save-dev

Downloads and installs the libraries listed in package.json.

โœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation