summaryrefslogtreecommitdiff
path: root/examples/with-markdown-shiki/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'examples/with-markdown-shiki/README.md')
-rw-r--r--examples/with-markdown-shiki/README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/examples/with-markdown-shiki/README.md b/examples/with-markdown-shiki/README.md
new file mode 100644
index 000000000..d97d1855d
--- /dev/null
+++ b/examples/with-markdown-shiki/README.md
@@ -0,0 +1,12 @@
+# Astro Example: Markdown with Shiki
+
+```
+npm init astro -- --template with-markdown-shiki
+```
+
+[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/with-markdown)
+
+This example showcases Astro's [built-in Markdown support](../../docs/markdown.md).
+
+- `src/pages/index.astro` uses Astro's `<Markdown>` component.
+- `src/pages/other.md` is a treated as a page entrypoint and uses a `layout`.