https://github.com/neo-hack/remark-config

remark config
https://github.com/neo-hack/remark-config

Last synced: over 1 year ago
JSON representation

remark config

• Host: GitHub
• URL: https://github.com/neo-hack/remark-config
• Owner: neo-hack
• License: mit
• Created: 2023-06-24T15:21:44.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-08-01T02:27:10.000Z (almost 2 years ago)
• Last Synced: 2025-02-04T19:40:43.647Z (over 1 year ago)
• Language: TypeScript
• Homepage:
• Size: 605 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

          
# remark-config

[![npm](https://img.shields.io/npm/v/@aiou/remark-config)](https://github.com/neo-hack/remark-config) [![GitHub](https://img.shields.io/npm/l/@aiou/remark-config)](https://github.com/neo-hack/remark-config) [![stackblitz](https://img.shields.io/badge/%E2%9A%A1%EF%B8%8Fstackblitz-online-blue)](https://stackblitz.com/github/neo-hack/remark-config)

## usage

create `/.remarkrc.mjs`

```js

import preset from '@aiou/remark-config'

const config = {

  plugins: [preset]

}

export default config

```

### `lint script`

> require `remark-cli`

add `lint:md` script in `package.json`

```json

{

  "scripts": {

    "lint:md": "remark ."

  }

}

```

### `lint-staged`

create `.lintstagedrc.mjs`

```js

export default {

  // Lint Markdown files with remark

  '**/**/*.md': filenames => [

    `remark ${filenames.join(' ')} -o`,

  ],

}

```

## install

```console

pnpm i @aiou/remark-config

```

## development

- **Setup** - `pnpm i`

- **Build** - `pnpm build`

#



*built with ❤️ by 😼*