diff options
Diffstat (limited to 'packages/markdown/component/readme.md')
| -rw-r--r-- | packages/markdown/component/readme.md | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/packages/markdown/component/readme.md b/packages/markdown/component/readme.md new file mode 100644 index 000000000..aa48e274d --- /dev/null +++ b/packages/markdown/component/readme.md @@ -0,0 +1,17 @@ +# @astrojs/markdown + +This package brings legacy support for the `<Markdown />` component to all Astro projects. + +> The `<Markdown />` component does not work in SSR. Consider [importing Markdown content](https://docs.astro.build/en/guides/markdown-content/#importing-markdown) instead. +::: + +```astro +--- +import Markdown from '@astrojs/markdown-component'; +--- +<Markdown> + # Markdown syntax is now supported! **Yay!** +</Markdown> +``` + +See our [Markdown Guide](https://docs.astro.build/en/guides/markdown-content/) for more info. |