diff options
| author |  Matthew Phillips <matthew@skypack.dev>
| 2022-07-20 16:45:05 -0400 |
|---|---|---|
| committer |  GitHub <noreply@github.com>
| 2022-07-20 16:45:05 -0400 |
| commit | bccd88f0ebe1fbf383c0cee4b27a4c24c72dea72 (patch) | |
| tree | 6ba2a85c65fac8ee0fd7d99c4c7f1b715789d76d /packages/markdown/component/readme.md | |
| parent | d13afad272bd558efadbc64de29f307bd58d8de1 (diff) | |
| download | astro-bccd88f0ebe1fbf383c0cee4b27a4c24c72dea72.tar.gz astro-bccd88f0ebe1fbf383c0cee4b27a4c24c72dea72.tar.zst astro-bccd88f0ebe1fbf383c0cee4b27a4c24c72dea72.zip | |
Move the Markdown component to its own package (#3986)
* Move the Markdown component to its own package
* Update the examples
* Updated lockfile
* Use is:raw
* Add a main field
* Update the formatting of the readme
* Rename to @astrojs/markdown-component
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. |