https://github.com/telus/remark-config

remark preset to configure remark-lint with rules that enforce the markdown style guide
https://github.com/telus/remark-config

guide markdown platform preset remark security-kpi style telus-digital

Last synced: 5 days ago
JSON representation

remark preset to configure remark-lint with rules that enforce the markdown style guide

• Host: GitHub
• URL: https://github.com/telus/remark-config
• Owner: telus
• License: mit
• Created: 2018-08-29T20:50:29.000Z (about 6 years ago)
• Default Branch: main
• Last Pushed: 2024-06-16T09:45:58.000Z (5 months ago)
• Last Synced: 2024-10-28T14:16:30.823Z (23 days ago)
• Topics: guide, markdown, platform, preset, remark, security-kpi, style, telus-digital
• Language: JavaScript
• Homepage: https://telus.com/digital
• Size: 836 KB
• Stars: 0
• Watchers: 15
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![maintenance-status](https://img.shields.io/badge/maintenance-deprecated-red.svg)

![npm](https://img.shields.io/npm/v/@telus/remark-config)

# Remark Config

Remark preset to configure `remark-lint` with settings that inherit from [`remark-preset-lint-markdown-style-guide`](https://github.com/remarkjs/remark-lint/tree/master/packages/remark-preset-lint-markdown-style-guide) with some customization for usage at TELUS.

## Usage

###### 1. Install

```sh

npm install --save-dev remark-cli @telus/remark-config

```

###### 2. Configure

include a `.remarkrc` file in your project root directory:

```json

{

  "plugins": [

    "@telus/remark-config"

  ]

}

```

###### 3. Run

```sh

remark --quiet --frail .

```

###### 4. Add to your `npm scripts` (recommended)

```json

"scripts": {

  "lint:markdown": "remark --quiet --frail ."

  ...

}

```

---

> Github: [@telus](https://github.com/telus) • 

> Twitter: [@telusdigital](https://twitter.com/telusdigital)