Skip to content

Update customization instructions for prose components #450

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
aloky wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update customization instructions for prose components #450

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8827690
Update customization instructions for prose components
aloky Dec 16, 2025
0047b47
Add comment for global MyCustomPComponent usage
aloky Dec 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,14 +128,14 @@ export default defineNuxtConfig({
components: {
prose: false, // Disable predefined prose components
map: {
p: 'MyCustomPComponent'
p: 'MyCustomPComponent' // add global like MyCustomPComponent.global.vue
}
}
}
})
```

In order to customize these components yourself simply make a component with the same name of the prose component you are trying to take control over. Make sure to put these prose components in their own prose folder and tell nuxt to globally register them so that MDC can get proper access.
In order to customize these components yourself simply make a component with the same name of the prose component you are trying to take control over. Make sure to put these prose components in their own prose folder and tell nuxt to globally register or simple create in `prose` folder `P.global.vue` them so that MDC can get proper access.

```ts
export default defineNuxtConfig({
Expand Down