From 6f1c4ea388bf03228e3b6e86997122f07233d02b Mon Sep 17 00:00:00 2001
From: zyoshoka <107108195+zyoshoka@users.noreply.github.com>
Date: Fri, 7 Jul 2023 20:22:47 +0900
Subject: [PATCH] Fix code snippet in markdoc README (#7592)
---
packages/integrations/markdoc/README.md | 20 ++++++++------------
1 file changed, 8 insertions(+), 12 deletions(-)
diff --git a/packages/integrations/markdoc/README.md b/packages/integrations/markdoc/README.md
index 2303b44654..4250813d38 100644
--- a/packages/integrations/markdoc/README.md
+++ b/packages/integrations/markdoc/README.md
@@ -105,13 +105,12 @@ This example renders an `Aside` component, and allows a `type` prop to be passed
```js
// markdoc.config.mjs
-import { defineMarkdocConfig } from '@astrojs/markdoc/config';
-import Aside from './src/components/Aside.astro';
+import { defineMarkdocConfig, component } from '@astrojs/markdoc/config';
export default defineMarkdocConfig({
tags: {
aside: {
- render: Aside,
+ render: component('./src/components/Aside.astro'),
attributes: {
// Markdoc requires type defs for each attribute.
// These should mirror the `Props` type of the component
@@ -145,14 +144,13 @@ This example renders a `Heading.astro` component using the `render` property:
```js
// markdoc.config.mjs
-import { defineMarkdocConfig, nodes } from '@astrojs/markdoc/config';
-import Heading from './src/components/Heading.astro';
+import { defineMarkdocConfig, nodes, component } from '@astrojs/markdoc/config';
export default defineMarkdocConfig({
nodes: {
heading: {
...nodes.heading, // Preserve default anchor link generation
- render: Heading,
+ render: component('./src/components/Heading.astro'),
},
},
});
@@ -239,14 +237,13 @@ This example renders blockquotes with a custom `Quote.astro` component:
```js
// markdoc.config.mjs
-import { defineMarkdocConfig, nodes } from '@astrojs/markdoc/config';
-import Quote from './src/components/Quote.astro';
+import { defineMarkdocConfig, nodes, component } from '@astrojs/markdoc/config';
export default defineMarkdocConfig({
nodes: {
blockquote: {
...nodes.blockquote, // Apply Markdoc's defaults for other options
- render: Quote,
+ render: component('./src/components/Quote.astro'),
},
},
});
@@ -273,13 +270,12 @@ This Astro component can now be passed to the `render` prop for any [tag][markdo
```js
// markdoc.config.mjs
-import { defineMarkdocConfig } from '@astrojs/markdoc/config';
-import ClientAside from './src/components/ClientAside.astro';
+import { defineMarkdocConfig, component } from '@astrojs/markdoc/config';
export default defineMarkdocConfig({
tags: {
aside: {
- render: ClientAside,
+ render: component('./src/components/ClientAside.astro'),
attributes: {
type: { type: String },
},