summaryrefslogtreecommitdiff
path: root/examples/with-markdown/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'examples/with-markdown/README.md')
-rw-r--r--examples/with-markdown/README.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/examples/with-markdown/README.md b/examples/with-markdown/README.md
new file mode 100644
index 000000000..fa0ac5030
--- /dev/null
+++ b/examples/with-markdown/README.md
@@ -0,0 +1,6 @@
+# Astro 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`.