Skip to content

neo-hack/remark-config

Repository files navigation

remark-config

npm GitHub stackblitz

usage

create <root>/.remarkrc.mjs

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

{
  "scripts": {
    "lint:md": "remark ."
  }
}

lint-staged

create .lintstagedrc.mjs

export default {
  // Lint Markdown files with remark
  '**/**/*.md': filenames => [
    `remark ${filenames.join(' ')} -o`,
  ],
}

install

pnpm i @aiou/remark-config

development

  • Setup - pnpm i
  • Build - pnpm build

built with ❤️ by 😼