summaryrefslogtreecommitdiff
path: root/docs/reference/builtin-components.md
diff options
context:
space:
mode:
authorGravatar Fred K. Schott <fkschott@gmail.com> 2021-06-29 13:12:27 -0700
committerGravatar Fred K. Schott <fkschott@gmail.com> 2021-06-29 13:12:27 -0700
commit9c7921300c5aae35ee947be5fc515e5b3fdaf1a2 (patch)
tree94dc4d802341e827466f641de97acf74905c706c /docs/reference/builtin-components.md
parent4df98a79f8d5f14e9e049322a6eef2db4f985ae4 (diff)
parent279a25246260ef95459d29c8029b18bd89adc206 (diff)
downloadastro-9c7921300c5aae35ee947be5fc515e5b3fdaf1a2.tar.gz
astro-9c7921300c5aae35ee947be5fc515e5b3fdaf1a2.tar.zst
astro-9c7921300c5aae35ee947be5fc515e5b3fdaf1a2.zip
Merge branch 'docs-sync-1'
Diffstat (limited to 'docs/reference/builtin-components.md')
-rw-r--r--docs/reference/builtin-components.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/docs/reference/builtin-components.md b/docs/reference/builtin-components.md
new file mode 100644
index 000000000..1ea265351
--- /dev/null
+++ b/docs/reference/builtin-components.md
@@ -0,0 +1,32 @@
+---
+layout: ~/layouts/Main.astro
+title: Astro Builtin Components
+---
+
+Astro includes several builtin components for you to use in your projects. All builtin components are available via `import {} from 'astro/components';`.
+
+## `<Markdown />`
+
+```astro
+---
+import { Markdown } from 'astro/components';
+---
+<Markdown>
+ # Markdown syntax is now supported! **Yay!**
+</Markdown>
+```
+
+See our [Markdown Guide](/docs/guides/markdown-content.md) for more info.
+<!-- TODO: We should move some of the specific component info here. -->
+
+
+## `<Prism />`
+
+```astro
+---
+import { Prism } from 'astro/components';
+---
+<Prism code={`const foo = 'bar';`} />
+```
+
+This component provides syntax highlighting for code blocks. Since this never changes in the client it makes sense to use an Astro component (it's equally reasonable to use a framework component for this kind of thing; Astro is server-only by default for all frameworks!).