https://github.com/keplersj/remark-preset-lint-retext-english

remark-lint preset for automated proofreading of English text using retext
https://github.com/keplersj/remark-preset-lint-retext-english

english proofreading remark remark-lint remark-preset retext writing

Last synced: 6 months ago
JSON representation

remark-lint preset for automated proofreading of English text using retext

• Host: GitHub
• URL: https://github.com/keplersj/remark-preset-lint-retext-english
• Owner: keplersj
• License: mit
• Created: 2019-12-19T21:26:32.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-12-13T23:40:17.000Z (6 months ago)
• Last Synced: 2024-12-14T00:26:29.515Z (6 months ago)
• Topics: english, proofreading, remark, remark-lint, remark-preset, retext, writing
• Language: JavaScript
• Size: 3.64 MB
• Stars: 4
• Watchers: 4
• Forks: 1
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# remark-preset-lint-retext-english

[![npm](https://img.shields.io/npm/v/remark-preset-lint-retext-english)](https://www.npmjs.com/package/remark-preset-lint-retext-english)

[![npm](https://img.shields.io/npm/dw/remark-preset-lint-retext-english)](https://www.npmjs.com/package/remark-preset-lint-retext-english)

[![Codecov](https://img.shields.io/codecov/c/github/keplersj/remark-preset-lint-retext-english)](https://app.codecov.io/gh/keplersj/remark-preset-lint-retext-english)

[![Bundle Size](https://img.shields.io/bundlephobia/min/remark-preset-lint-retext-english)](https://bundlephobia.com/package/remark-preset-lint-retext-english)

[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://www.conventionalcommits.org/)

[`remark-lint`](https://github.com/remarkjs/remark-lint) preset for automated proofreading of English text using [`retext`](https://github.com/remarkjs/remark-lint).

# Installation

```bash

$ npm install --save-dev remark-preset-lint-retext-english

```

## Usage

Set the following in your package.json:

```json

{

  "remarkConfig": {

    "plugins": ["remark-preset-lint-retext-english"]

  }

}

```

Run remark. Either [`remark-cli`](https://github.com/remarkjs/remark/tree/master/packages/remark-cli) or [`jest-runner-remark`](https://github.com/keplersj/jest-runner-remark) is recommended for this.

## License

Copyright 2019-2022 [Kepler Sticka-Jones](https://keplersj.com). Licensed MIT.