Skip to content

README.md

Latest commit

 

History

History
36 lines (26 loc) · 815 Bytes

README.md

File metadata and controls

36 lines (26 loc) · 815 Bytes

textlint-plugin-rustdoc

NPM Version

textlint plugin to support rustdoc comments.

Installation

# npm
npm add -D @mirror-kt/textlint-plugin-rustdoc

# yarn
yarn add -D @mirror-kt/textlint-plugin-rustdoc

# pnpm
pnpm add -D @mirror-kt/textlint-plugin-rustdoc

And write the following content in the textlint configuration file (e.x. .textlintrc.json).

{
  "plugins": {
    "@mirror-kt/textlint-plugin-rustdoc": true
  },
  "rules": {
    // your rules...
  }
}

License

This project is licensed under MIT License.