This package implements the rules of the [Sven Greb Markdown style guide][1] as an extensible [remark-lint][9] rule preset. It supports all [official core rules][7] and [various plugins][4] like the [“frontmatter” Markdown extension][5] for [YAML][18] and [TOML][10] and [“GitHub Flavoured” Markdown][6].
## Getting Started
Note that this package uses [npm version 7.7.0 or higher][2] as the main package manager, but the documentations also include instructions to work with [Yarn][19] (classic / `v1`).
### Installation
Add the package as development dependency to your project:
```sh
# With npm...
npm install --save-dev @svengreb/remark-preset-lint
# or Yarn.
yarn add --dev @svengreb/remark-preset-lint
```
Note that [peer dependencies][12], like the [remark-lint][9] package itself, are **only installed automatically when using a npm version equal or higher than `7.0.0`**, otherwise they must be installed separately like described in the [peer dependencies](#peer-dependencies) section below.
See the [Node distribution index][13] for more information about which npm version is bundled with which Node version.
#### Peer Dependencies
This package depends on [various remark-lint rule packages][8] that are defined as [peer dependencies][12].
##### npm versions `>=7.0.0`
As of **npm version `7.0.0`, peer dependencies are** [**installed automatically**][3] and does not require any additional steps.
##### npm versions `>=5.0.0 <7.0.0`
For **npm version equal to or higher than `5.0.0` (pre-bundled with [Node.js 8][14]) but less than `7.0.0`**, all peer dependencies can be auto-installed using the pre-bundled [`npx`][16] package:
```sh
npx install-peerdeps --dev @svengreb/remark-preset-lint
```
##### npm versions `<5.0.0`
If you’re using a **npm version less than `5.0.0`**, the `npx` package is not pre-bundled, but users can either simply install the [`npx`][16] package globally to run the above command or use the [install-peerdeps][15] helper package locally/globally to let it handle the installation of all peer dependencies:
```sh
# Install and use the "install-peerdeps" helper package locally...
npm install install-peerdeps
./node_modules/.bin/install-peerdeps --dev @svengreb/remark-preset-lint
# ...or globally.
npm install --global install-peerdeps
install-peerdeps --dev @svengreb/remark-preset-lint
```
To install all peer dependencies manually without `npx` or any helper package, the npm `info` command can be used to get a list of all packages and their versions:
```sh
# List the names and versions of all peer dependencies...
npm info "@svengreb/remark-preset-lint" peerDependencies
# ...and install each listed package manually.
npm install PACKAGE@VERSION
```
##### Using Yarn instead of npm
If you’re not using npm but Yarn, peer dependencies can be installed by either adding them manually or using the [install-peerdeps][15] helper package:
```sh
# Either add all packages manually by listing all required names and their versions and install them manually...
yarn info @svengreb/remark-preset-lint peerDependencies
yarn add --dev remark-lint #...
# ...or use the "install-peerdeps" helper package.
yarn add --dev install-peerdeps
yarn run install-peerdeps --dev @svengreb/remark-preset-lint
```
## Usage
The package can be used as rule preset by adding it to the plugins within your `.remarkrc.js` or `.remarkrc` [configuration file][17]:
```js
module.exports = {
plugins: ["@svengreb/remark-preset-lint"],
};
```
## Contributing
Please read the [contribution guidelines][11] of the [Sven Greb Markdown style guide][1] for more details.
