File tree Expand file tree Collapse file tree 1 file changed +15
-0
lines changed Expand file tree Collapse file tree 1 file changed +15
-0
lines changed Original file line number Diff line number Diff 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
250265When modifying developer setup scripts in `website/docs/developers/scripts/`,
You can’t perform that action at this time.
0 commit comments