Skip to content

Latest commit

 

History

History
89 lines (59 loc) · 1.6 KB

README.md

File metadata and controls

89 lines (59 loc) · 1.6 KB

Shared remark configuration

The purpose of the remark is linting, formatting and autogenerate contents of markdown files (.md).


Contents

Setup

  • Add workspace reference to @muravjev/configs-remark and its peer dependencies:

    pnpm add -w @muravjev/configs-remark remark remark-cli
  • Add remark configuration file:

    // .remarkrc.mjs
    
    export { default } from '@muravjev/configs-remark';
  • Add remark ignore patterns file:

    # .remarkignore
    
    node_modules/
    
    # Next ignore patterns
    .next/
    .build/
    .coverage/
    
    # Custom ignore patterns
    ...
  • Add remark scripts:

    // package.json
    
    "scripts": {
      ...
      "remark": "remark",
      "remark:fix": "pnpm remark --output --"
      ...
    }

Automation

Usage

  • Automatic validation file with remark on save.

  • Automatic validation of staged files with remark on commit.

  • Manual usage from command line:

    pnpm remark .
    pnpm remark:fix .

Donation

If you found this project helpful, consider
buying me a coffee, donate by paypal or just leave a star
Thanks for your support, it is much appreciated!

License

MIT © Sergey Muravjev


⬅ Back