| 1 | # remark-preset-wooorm [![Build Status][travis-badge]][travis]
|
| 2 |
|
| 3 | My personal markdown (and prose) style.
|
| 4 |
|
| 5 | [Learn more about presets in unified’s docs][docs].
|
| 6 |
|
| 7 | ## Installation
|
| 8 |
|
| 9 | [npm][npm-install]:
|
| 10 |
|
| 11 | ```sh
|
| 12 | npm install remark-cli remark-preset-wooorm --save
|
| 13 | ```
|
| 14 |
|
| 15 | Now add the following to your `package.json`:
|
| 16 |
|
| 17 | ```js
|
| 18 | "scripts": {
|
| 19 | "build-md": "remark ."
|
| 20 | "test": "npm run build-md && ..."
|
| 21 | },
|
| 22 | "remarkConfig": {
|
| 23 | "plugins": [
|
| 24 | "preset-wooorm"
|
| 25 | ]
|
| 26 | },
|
| 27 | ```
|
| 28 |
|
| 29 | From now on, `npm test` also checks markdown.
|
| 30 |
|
| 31 | ```sh
|
| 32 | npm test
|
| 33 | ```
|
| 34 |
|
| 35 | ## Checks
|
| 36 |
|
| 37 | ###### Markdown
|
| 38 |
|
| 39 | * Extends [`remark-preset-lint-recommended`][lint-recommended],
|
| 40 | and adds a strict code-style (see [`index.js`][index])
|
| 41 | * Checks [broken local links][validate-links]
|
| 42 | * Markdown is compiled with asterisk list-item bullets (`*`),
|
| 43 | and fenced code blocks (note: set `output: true` in your config to
|
| 44 | benefit from this)
|
| 45 | * How remark compiles can be configured inline with [comments][]
|
| 46 | * `Table of Contents` headers are kept up to date, with a depth of `3`
|
| 47 | (if `output: true`)
|
| 48 | * [GH references][github], like mentions or issue references, are
|
| 49 | linked (if `output: true`)
|
| 50 |
|
| 51 | ###### Natural Language
|
| 52 |
|
| 53 | See [`retext-preset-wooorm`][retext-preset] for more info.
|
| 54 |
|
| 55 | * [English][] parsing
|
| 56 | * Two [spaces][] between sentences
|
| 57 | * Checks [“indefinite articles”][articles]: “a” or “an”
|
| 58 | * Checks [quotes and apostrophes][quotes] (`""` > `“”`)
|
| 59 | * Checks accidental [repeated words][repeated]
|
| 60 | * Checks [diacritics][]
|
| 61 | * Checks [redundant acronyms][ras]
|
| 62 | * Checks incorrectly placed apostrophes in [contractions][]
|
| 63 |
|
| 64 | ## License
|
| 65 |
|
| 66 | [MIT][license] © [Titus Wormer][author]
|
| 67 |
|
| 68 |
|
| 69 |
|
| 70 | [travis-badge]: https://img.shields.io/travis/wooorm/remark-preset-wooorm.svg
|
| 71 |
|
| 72 | [travis]: https://travis-ci.org/wooorm/remark-preset-wooorm
|
| 73 |
|
| 74 | [npm-install]: https://docs.npmjs.com/cli/install
|
| 75 |
|
| 76 | [license]: LICENSE
|
| 77 |
|
| 78 | [author]: http://wooorm.com
|
| 79 |
|
| 80 | [index]: ./index.js
|
| 81 |
|
| 82 | [lint-recommended]: https://github.com/wooorm/remark-lint/tree/master/packages/remark-preset-lint-recommended
|
| 83 |
|
| 84 | [validate-links]: https://github.com/wooorm/remark-validate-links
|
| 85 |
|
| 86 | [github]: https://github.com/wooorm/remark-github
|
| 87 |
|
| 88 | [comments]: https://github.com/wooorm/remark-comment-config
|
| 89 |
|
| 90 | [retext-preset]: https://github.com/wooorm/retext-preset-wooorm
|
| 91 |
|
| 92 | [english]: https://github.com/wooorm/retext/tree/master/packages/retext-english
|
| 93 |
|
| 94 | [spaces]: https://github.com/wooorm/retext-sentence-spacing
|
| 95 |
|
| 96 | [articles]: https://github.com/wooorm/retext-indefinite-article
|
| 97 |
|
| 98 | [quotes]: https://github.com/wooorm/retext-quotes
|
| 99 |
|
| 100 | [repeated]: https://github.com/wooorm/retext-repeated-words
|
| 101 |
|
| 102 | [contractions]: https://github.com/wooorm/retext-contractions
|
| 103 |
|
| 104 | [diacritics]: https://github.com/wooorm/retext-diacritics
|
| 105 |
|
| 106 | [ras]: https://github.com/wooorm/retext-redundant-acronyms
|
| 107 |
|
| 108 | [docs]: https://github.com/unifiedjs/unified#preset
|