https://github.com/ladjs/remark-preset-github

GitHub markdown and prose style
https://github.com/ladjs/remark-preset-github

automatic formatting github markdown node npm preset prose remark syntax

Last synced: about 8 hours ago
JSON representation

GitHub markdown and prose style

• Host: GitHub
• URL: https://github.com/ladjs/remark-preset-github
• Owner: ladjs
• License: mit
• Created: 2017-08-21T04:36:55.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2022-06-06T05:22:53.000Z (over 2 years ago)
• Last Synced: 2024-10-14T07:18:53.462Z (25 days ago)
• Topics: automatic, formatting, github, markdown, node, npm, preset, prose, remark, syntax
• Language: JavaScript
• Size: 854 KB
• Stars: 6
• Watchers: 2
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# remark-preset-github

GitHub markdown and prose style.

[Learn more about presets in unified's docs][docs].

> **NOTE**: Feel free to open an issue if something isn't working right.

## Installation

[npm][npm-install]:

```sh

npm install remark-cli remark-preset-github --save

```

Now add the following to your `package.json`:

```js

  "scripts": {

    "build-md": "remark ."

    "test": "npm run build-md && ..."

  },

  "remarkConfig": {

    "plugins": [

      "preset-github"

    ]

  },

```

From now on, `npm test` also checks markdown.

```sh

npm test

```

## Checks

###### Markdown

* Adds a [license section][remark-license]

* Adds a [contributors section][remark-contributors]

* Extends [`remark-preset-lint-recommended`][lint-recommended],

  and adds a strict code-style (see [`index.js`][index])

* Markdown is compiled with asterisk list-item bullets (`*`),

  and fenced code blocks (note: set `output: true` in your config to

  benefit from this)

* How remark compiles can be configured inline with [comments][comments]

* `Table of Contents` headers are kept up to date, with a depth of `3`

  (if `output: true`)

* [GH references][github], like mentions or issue references, are

  linked (if `output: true`)

###### Natural Language

See [`retext-preset-github`][retext-preset] for more info.

* [English][english] parsing

* Two [spaces][spaces] between sentences

* Checks ["indefinite articles"][articles]: "a" or "an"

* Checks [quotes and apostrophes][quotes] (`“”` > `""`)

* Checks accidental [repeated words][repeated]

* Checks [diacritics][diacritics]

* Checks [redundant acronyms][ras]

* Checks incorrectly placed apostrophes in [contractions][contractions]

## Contributors

| Name           | website                    |

| -------------- | -------------------------- |

| **Nick Baugh** |  |

## License

[MIT](LICENSE) © Titus Wormer

##

[npm-install]: https://docs.npmjs.com/cli/install

[index]: ./index.js

[lint-recommended]: https://github.com/wooorm/remark-lint/tree/master/packages/remark-preset-lint-recommended

[github]: https://github.com/wooorm/remark-github

[comments]: https://github.com/wooorm/remark-comment-config

[retext-preset]: https://github.com/niftylettuce/retext-preset-github

[english]: https://github.com/wooorm/retext/tree/master/packages/retext-english

[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

[remark-license]: https://github.com/wooorm/remark-license

[remark-contributors]: https://github.com/hughsk/remark-contributors