From 95bb639b1510c3ee05dbfb46f3b3bd07f6661c03 Mon Sep 17 00:00:00 2001
From: oneminch <27751688+oneminch@users.noreply.github.com>
Date: Mon, 4 May 2026 15:23:12 -0400
Subject: [PATCH 1/2] docs: clarify indentation when using components
---
README.md | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 50 insertions(+)
diff --git a/README.md b/README.md
index 0a28c6a3..a0cd12ad 100644
--- a/README.md
+++ b/README.md
@@ -124,6 +124,56 @@ It is the default behavior of markdown to wrap every text inside a paragraph. MD
```
+### Slots in MDC components
+
+When using your own components in Markdown (`::my-component ... ::`), **indentation inside the container matters**.
+
+For the renderer to work as expected, it's important that the indentation of the content nested *within* `::my-component ... ::` aligns with the indentation of the `::my-component` line itself.
+
+Consider the following component with a named slot:
+
+```html [Alert.vue]
+
+
`. + +It's recommended to keep `#slotName` and slot content aligned with the opening `::my-component` line (no extra indentation inside the container). + ### Prose Components Prose components are a list of components that will be rendered instead of regular HTML tags. For example, instead of rendering a `` tag, `@nuxtjs/mdc` renders a `
` component. This is useful when you want to add extra features to your markdown files. For example, you can add a `copy` button to your code blocks. From e84f1a56c5abcc3436d32e64435a636b458dac8f Mon Sep 17 00:00:00 2001 From: oneminch <27751688+oneminch@users.noreply.github.com> Date: Mon, 4 May 2026 15:51:49 -0400 Subject: [PATCH 2/2] fix: vue markup example typo and github callout casing --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a0cd12ad..11d7379b 100644 --- a/README.md +++ b/README.md @@ -135,7 +135,7 @@ Consider the following component with a named slot: ```html [Alert.vue] -``` @@ -169,7 +169,7 @@ In particular, **slot markers (for named slots) must not be indented relative to :: ``` -> [!note] +> [!NOTE] > When using default (unnamed) slots, content can still render, but if indented it may be parsed as a code block and end up wrapped in a `+ `. It's recommended to keep `#slotName` and slot content aligned with the opening `::my-component` line (no extra indentation inside the container).