Skip to content

kijimaD/textlint-plugin-org

Repository files navigation

npm version Build test lint License: GPL v3

textlint-plugin-org

Add Org mode support for textlint.

What is textlint plugin? Please see https://github.com/textlint/textlint/blob/master/docs/plugin.md

Try run by Docker

$ docker run -v "$(pwd)":/work \
             -w /work \
             --rm -it ghcr.io/kijimad/textlint-plugin-org \
             textlint \
             --plugin org \
             --rule textlint-rule-preset-ja-technical-writing \
             *.org

Install

$ npm install textlint-plugin-org

Usage

Via .textlintrc(Recommended)

{
    "plugins": [
        "org"
    ]
}
$ textlint test.org

Via CLI

$ textlint --plugin org test.org

Test

$ npm run test

Lint

$ npm run lint

Release

$ npm run build
$ npm version patch
$ npm login
$ npm publish