diff --git a/src/components/BodyText/BodyText.mdx b/src/components/BodyText/BodyText.mdx index 483c6b0e..3055be1a 100644 --- a/src/components/BodyText/BodyText.mdx +++ b/src/components/BodyText/BodyText.mdx @@ -33,7 +33,7 @@ Venison shoulder *ham hock ham leberkas*. Flank beef ribs fatback, jerky meatbal With the Graphics Kit, you'll likely get your text value from an ArchieML doc... ```yaml -# Archie ML doc +# ArchieML doc [blocks] type: text diff --git a/src/components/SEO/SEO.mdx b/src/components/SEO/SEO.mdx new file mode 100644 index 00000000..1772a3be --- /dev/null +++ b/src/components/SEO/SEO.mdx @@ -0,0 +1,80 @@ +import { Meta, Canvas } from '@storybook/blocks'; + +import * as SEOStories from './SEO.stories.svelte'; + + + +# SEO + +The `SEO` component adds essential metadata to pages. + +```svelte + + + +``` + +## Using with ArchieML docs + +With the Graphics Kit, you'll likely get many of your text values from an ArchieML doc... + +```yaml +# ArchieML doc +slug: ROOT-SLUG/WILD +seoTitle: Page title for search +seoDescription: Page description for search +shareTitle: Page title for social media +shareDescription: Page description for social media +shareImgPath: images/reuters-graphics.jpg +shareImgAlt: Alt text for share image. +``` + +... which you'll pass to the `SEO` component. + +```svelte + + + +``` + +> **Note:** For _reasons_, we can't document the value of `VITE_BASE_URL` below. It's `import` + `.meta.env.BASE_URL` (concatenate all that) in the Graphics Kit and other Vite-based rigs. + + +``` diff --git a/src/components/SEO/SEO.stories.svelte b/src/components/SEO/SEO.stories.svelte index e09205b5..dc354359 100644 --- a/src/components/SEO/SEO.stories.svelte +++ b/src/components/SEO/SEO.stories.svelte @@ -1,49 +1,23 @@ - - - - +
View page source to see the SEO metadata.
- - diff --git a/src/components/SEO/SEO.svelte b/src/components/SEO/SEO.svelte index 96a91a91..dd407342 100644 --- a/src/components/SEO/SEO.svelte +++ b/src/components/SEO/SEO.svelte @@ -2,77 +2,59 @@ - - -``` - -> **Note:** For _reasons_, we can't document the value of `VITE_BASE_URL` below. It's `import` + `.meta.env.BASE_URL` (concatenate all that) in the Graphics Kit and other Vite-based rigs. - diff --git a/src/components/SEO/stories/docs/component.md b/src/components/SEO/stories/docs/component.md deleted file mode 100644 index 0b5c0aa2..00000000 --- a/src/components/SEO/stories/docs/component.md +++ /dev/null @@ -1,26 +0,0 @@ -The `SEO` component adds essential metadata to published pages. - -```svelte - - - -```