[WIP] Google Developer Documentation Style Guide for textlint.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
packages
test
tools
.babelrc
.gitignore
.travis.yml
LICENSE
README.md
lerna.json
package.json
yarn.lock

README.md

textlint-rule-preset-google Build Status

Google Developer Documentation Style Guide for textlint.

Install

Install with npm:

npm install @textlint-rule/textlint-rule-preset-google

Usage

Via .textlintrc(Recommended)

{
    "rules": {
        "@textlint-rule/preset-google": true
    }
}

Via CLI

textlint --rule preset-google README.md

Rules

Remember that everything in this guide is a guideline, not a draconian rule.

Changelog

See Releases page.

Running tests

This monorepo use Yarn.

Install dependencies and Run npm test:

yarn install
yarn bootstrap
yarn test

Contributing

For bugs and feature requests, please create an issue.

Pull requests and stars are always welcome.

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

Adding new rule

  1. Create pacakges/textlint-rule-<rule-name>
  2. Setup package using textlint-scripts.
  3. Write rule
  4. Test rule
  5. Submit Pull Request!

Author

License

MIT © azu