Skip to main content

textlintThe pluggable linting tool for natural language

textlint is an open source text linting utility written in JavaScript. It is hard to lint natural language texts, but we try to resolve this issue by pluggable approach.
Rules

Rules

To use a rule, simply run npm install textlint-rule-xxx. See the collection of textlint rules.

Markdown & Texts

Markdown & Texts

Markdown and plain text are supported by default. HTML and other formats are offered by custom plugins.

Custom Formatters

Custom Formatters

Formatter is used both by bundled and custom formatters.

Getting Started

Follow these steps to get started with textlint:
Check out our documentation for more details.

  1. Create your project:
    npm init --yes
  2. Install textlint into your project:
    npm install --save-dev textlint
  3. Install textlint rule:
    npm install --save-dev textlint-rule-no-todo
  4. Create .textlintrc file:
    npx textlint --init
  5. Run textlint:
    npx textlint README.md
  1. Initialize project with npm init
  2. Install textlint package
  3. Install textlint rule
  4. Initialize textlint configuration
  5. Run textlint command

Playground

Take textlint for a spin, start typing below.
Want to try more? Go to playground.

Who's Using This?

This project is used by all these people. More textlint users.

JavaScript Primerjp.vuejs.orgSURVIVEJS - WEBPACKHoodieGIS実習オープン教材株式会社ソラコム校正さん