Skip to content

Commit cea13f5

Browse files
committed
CLAUDE: add instructions to ignore prettier
1 parent ea213ec commit cea13f5

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

CLAUDE.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -245,6 +245,21 @@ files.
245245
- Maintain proper capitalization for proper nouns and technical terms
246246
- Apply this style consistently across all documentation files
247247

248+
**Docusaurus admonitions (:::note, :::caution, :::info, etc.):**
249+
250+
- Always wrap Docusaurus admonitions with `<!-- prettier-ignore-start -->` and
251+
`<!-- prettier-ignore-stop -->` comments
252+
- This prevents prettier from reformatting the admonition blocks
253+
- Example:
254+
255+
```mdx
256+
<!-- prettier-ignore-start -->
257+
258+
:::note Content of the note here :::
259+
260+
<!-- prettier-ignore-stop -->
261+
```
262+
248263
### Documentation Script Testing
249264

250265
When modifying developer setup scripts in `website/docs/developers/scripts/`,

0 commit comments

Comments
 (0)