https://github.com/ladjs/retext-preset-github
GitHub prose style
https://github.com/ladjs/retext-preset-github
Last synced: 11 months ago
JSON representation
GitHub prose style
- Host: GitHub
- URL: https://github.com/ladjs/retext-preset-github
- Owner: ladjs
- License: mit
- Created: 2017-08-21T04:30:37.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2019-08-30T08:14:07.000Z (over 6 years ago)
- Last Synced: 2025-02-20T00:36:43.848Z (11 months ago)
- Language: JavaScript
- Size: 78.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# retext-preset-github
GitHub prose style.
[Learn more about presets in unified’s docs][docs].
## Installation
```sh
npm install retext-preset-github --save
```
## Checks
###### Natural Language
* Two [spaces][] between sentences
* Checks ["indefinite articles"][articles]: "a" or "an"
* Checks [quotes and apostrophes][quotes] (`“”` > `""`)
* Checks accidental [repeated words][repeated]
* Checks [diacritics][]
* Checks [redundant acronyms][ras]
* Checks incorrectly placed apostrophes in [contractions][]
## Related
* [`remark-preset-github`](https://github.com/niftylettuce/remark-preset-github) - GitHub markdown style
## License
[MIT][license] © [Titus Wormer][author]
[npm]: https://docs.npmjs.com/cli/install
[license]: LICENSE
[author]: http://wooorm.com
[spaces]: https://github.com/wooorm/retext-sentence-spacing
[articles]: https://github.com/wooorm/retext-indefinite-article
[quotes]: https://github.com/wooorm/retext-quotes
[repeated]: https://github.com/wooorm/retext-repeated-words
[contractions]: https://github.com/wooorm/retext-contractions
[diacritics]: https://github.com/wooorm/retext-diacritics
[ras]: https://github.com/wooorm/retext-redundant-acronyms
[docs]: https://github.com/unifiedjs/unified#preset