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 import config from '@muravjev/configs-remark'; export default config;
-
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
- Setup
➡ remark vscode plugin to integrateremark
with vscode environment.
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!