# stylelint-formatter-markdown

> Format your stylelint reports as Markdown tables

Latest version **1.0.0** (published 2019-09-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install stylelint-formatter-markdown
pnpm add stylelint-formatter-markdown
yarn add stylelint-formatter-markdown
bun add stylelint-formatter-markdown
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2019-09-19 |
| First published | 2019-09-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Shawn Allen |
| Maintainers | shawnbot |
| Keywords | stylelint, stylelint-formatter, markdown |

## Links

- npm: https://www.npmjs.com/package/stylelint-formatter-markdown
- npm.io page: https://npm.io/package/stylelint-formatter-markdown

## Dependencies (1)

- [stylelint-formatter-utils](https://npm.io/package/stylelint-formatter-utils.md) ^1.1.0

## Alternatives

- [eslint-plugin-sonarjs](https://npm.io/package/eslint-plugin-sonarjs.md) — 2.9M weekly downloads
- [eslint-config-expo](https://npm.io/package/eslint-config-expo.md) — 1.5M weekly downloads
- [@matter/protocol](https://npm.io/package/@matter/protocol.md) — 63.5K weekly downloads
- [@eventcatalog/linter](https://npm.io/package/@eventcatalog/linter.md) — 24.8K weekly downloads
- [@inrupt/eslint-config-base](https://npm.io/package/@inrupt/eslint-config-base.md) — 4.5K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2019-09-19
- 0.0.0-fd6a275 (canary) — 2019-12-30
- 0.0.0-47d8940 — 2019-09-19
- 0.0.0-6aed9f9 — 2019-09-19

## README

# stylelint-formatter-markdown
Format your stylelint results as Markdown tables with helpful links!

## Example output

| rule | path | text |
| :--- | :--- | :--- |
| [color-no-invalid-hex](https://stylelint.io/user-guide/rules/color-no-invalid-hex) | [test.css](https://github.com/stylelint-formatter-markdown/shawnbot/blob//test.css#L1) | Unexpected invalid hex color "#asldfkjas" (color-no-invalid-hex) |

## Install
```
npm install -D stylelint-formatter-markdown
```

## Usage
You've got two options:

1. Run the `stylelint` CLI with `--custom-formatter=node_modules/stylelint-formatter-markdown`.
2. Create your own `formatter.js` that looks like this:

    ```js
    // markdown-formatter.js
    module.exports = require('stylelint-formatter-markdown')
    ```

    And then run the `stylelint` CLI with `--custom-formatter=markdown-formatter.js`.

---
_Source: https://npm.io/package/stylelint-formatter-markdown · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._