Package detail

@mintlify/prettier-config

mintlify2.1kMIT1.0.6

Mintlify shared prettier config

readme

Shared Prettier configuration

Prettier is used for code formatting.

Add Dependencies

Install this package and peerDependencies of this package as devDependencies in the project, using install-peerdeps.

npx install-peerdeps --dev @mintlify/prettier-config

Alternatively, you can install this package as devDependency and install the peerDependencies separately.

# yarn
yarn add -D @mintlify/prettier-config

# npm
npm i -D @mintlify/prettier-config

# pnpm
pnpm add -D @mintlify/prettier-config

Add Configuration File

Create a .prettierrc file in the project root with the following content:

"@mintlify/prettier-config/config.js"

Add Formatting Scripts

Add the following package.json scripts (with the appropriate file extensions for the project):

"scripts": {
    "format": "prettier \"**/*.{css,js,ts,tsx,md,mdx}\" --write",
    "format:check": "prettier \"**/*.{css,js,ts,tsx,md,mdx}\" --check",
    ...
}