| 1 | --- |
| 2 | name: prettier-plugin |
| 3 | description: Format Slidev markdown files correctly |
| 4 | --- |
| 5 | |
| 6 | # Prettier Plugin |
| 7 | |
| 8 | Format Slidev markdown files correctly. |
| 9 | |
| 10 | ## Installation |
| 11 | |
| 12 | ```bash |
| 13 | pnpm i -D prettier prettier-plugin-slidev |
| 14 | ``` |
| 15 | |
| 16 | ## Configuration |
| 17 | |
| 18 | Create/modify `.prettierrc`: |
| 19 | |
| 20 | ```json |
| 21 | { |
| 22 | "overrides": [ |
| 23 | { |
| 24 | "files": ["slides.md", "pages/*.md"], |
| 25 | "options": { |
| 26 | "parser": "slidev", |
| 27 | "plugins": ["prettier-plugin-slidev"] |
| 28 | } |
| 29 | } |
| 30 | ] |
| 31 | } |
| 32 | ``` |
| 33 | |
| 34 | ## Why Needed |
| 35 | |
| 36 | Slidev's syntax (frontmatter, code blocks) may conflict with default Markdown formatting. This plugin understands Slidev-specific syntax. |
| 37 | |
| 38 | ## Note |
| 39 | |
| 40 | Must specify files via `overrides` since Slidev and regular Markdown share `.md` extension. |
| 41 |