summaryrefslogtreecommitdiff
path: root/examples/with-markdown/README.md
diff options
context:
space:
mode:
authorGravatar Nate Moore <natemoo-re@users.noreply.github.com> 2021-06-28 10:46:10 -0500
committerGravatar GitHub <noreply@github.com> 2021-06-28 10:46:10 -0500
commit7063c04dec48fcabcda104c42d61642a554f6044 (patch)
treeccc57515b9609f9a211154e2a783ab324ee1b8ed /examples/with-markdown/README.md
parent13f50564cb8cfece7857c7b08be064d5e9e9853a (diff)
downloadastro-7063c04dec48fcabcda104c42d61642a554f6044.tar.gz
astro-7063c04dec48fcabcda104c42d61642a554f6044.tar.zst
astro-7063c04dec48fcabcda104c42d61642a554f6044.zip
Restructure examples (#568)
* rename kitchen sink, pull out react example * split out the rest of the examples * align versions * chore: rename examples * chore: normalize gitignore * chore: update package versions * chore: move framework examples to `framework` namespace * docs: add README to examples Co-authored-by: Austin Crim <crim.austin@principal.com>
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`.