summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar AsyncBanana <58297401+AsyncBanana@users.noreply.github.com> 2021-10-18 14:35:16 -0400
committerGravatar GitHub <noreply@github.com> 2021-10-18 13:35:16 -0500
commit3cd1c2020bdf02dc0c2ec9ec551f7c861a310b6a (patch)
treeb9ecdbcf3ba01e3d7b341dbb04b7731cd2d29af9
parent8c739f9ed1f736906f966ccd66802c0b7cf177c0 (diff)
downloadastro-3cd1c2020bdf02dc0c2ec9ec551f7c861a310b6a.tar.gz
astro-3cd1c2020bdf02dc0c2ec9ec551f7c861a310b6a.tar.zst
astro-3cd1c2020bdf02dc0c2ec9ec551f7c861a310b6a.zip
Added frontmatter example to docs example (#1567)
Diffstat (limited to '')
-rw-r--r--examples/docs/README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/examples/docs/README.md b/examples/docs/README.md
index 26505fe43..83865d782 100644
--- a/examples/docs/README.md
+++ b/examples/docs/README.md
@@ -34,6 +34,7 @@ To deploy your site to production, check out our [Deploy an Astro Website](https
Welcome! Check out [our documentation](https://github.com/snowpackjs/astro) or jump into our [Discord server](https://astro.build/chat).
+
## Customize This Theme
### Site metadata
@@ -55,6 +56,22 @@ This theme uses a "cool blue" accent color by default. To customize this for you
+ --theme-accent: hsla(var(--color-red), 1); /* or: hsla(#FF0000, 1); */
```
+## Page metadata
+
+Astro uses frontmatter in Markdown pages to choose layouts and pass properties to those layouts. If you are using the default layout, you can customize the page in many different ways to optimize SEO and other things. For example, you can use the `title` and `description` properties to set the document title, meta title, meta description, and Open Graph description.
+
+```md
+---
+title: Example title
+description: Really cool docs example that uses Astro
+layout: ../../layouts/MainLayout.astro
+---
+
+# Page content...
+```
+
+For more SEO related properties, look at `src/components/HeadSEO.astro`
+
### Sidebar navigation