Skip to content

Commit d639fa9

Browse files
committed
style guide tweak
1 parent ca697bc commit d639fa9

File tree

1 file changed

+2
-17
lines changed

1 file changed

+2
-17
lines changed

src/content/docs/style-guide/components/render.mdx

Lines changed: 2 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -30,24 +30,9 @@ import { Render } from "~/components";
3030

3131
This should be the name of the partial, without the containing directory or file extension. For example, `/partials/style-guide/hello.mdx` would be `file="hello"`.
3232

33-
- `product` <Type text="string" /> <MetaInfo text="optional" />
33+
- `product` <Type text="string" />
3434

35-
By default, it will look for partials in the same product folder as the current page. You can use this to specify a different product.
36-
37-
:::caution
38-
39-
When using the `Render` component inside partials, the original `product` is lost.
40-
41-
For example, if there are three files:
42-
1. `docs/fundamentals/index.mdx`
43-
2. `partials/dns/thing.mdx`
44-
3. `partials/dns/thing2.mdx`
45-
46-
`docs/fundamentals/index.mdx` uses `<Render file="thing" product="dns" />`
47-
48-
`partials/dns/thing.mdx` must use `<Render file="thing2" product="dns" />` as `product` cannot be inferred.
49-
50-
:::
35+
This should be the folder within `src/partials`.
5136

5237
- `params` <Type text="object" /> <MetaInfo text="optional" />
5338

0 commit comments

Comments
 (0)