From 2657a77a5623dcf7f2d55dfafeda877dcf4f6061 Mon Sep 17 00:00:00 2001
From: Jon McClure <jon.r.mcclure@gmail.com>
Date: Fri, 26 Aug 2022 16:14:27 +0100
Subject: [PATCH] add component docs to new component template per #18

---
 bin/newComponent/template/YourComponent/YourComponent.svelte | 5 +++++
 src/components/SEO/stories/docs/quickit.md                   | 2 +-
 2 files changed, 6 insertions(+), 1 deletion(-)

diff --git a/bin/newComponent/template/YourComponent/YourComponent.svelte b/bin/newComponent/template/YourComponent/YourComponent.svelte
index ff961d08..5c78fc25 100644
--- a/bin/newComponent/template/YourComponent/YourComponent.svelte
+++ b/bin/newComponent/template/YourComponent/YourComponent.svelte
@@ -1,3 +1,8 @@
+<!--
+  @component The `YourComponent` component
+
+  [Docs](https://reuters-graphics.github.io/graphics-components/?path=/docs/components-YourComponent--default)
+-->
 <script lang="ts">
   /** ✏️ DOCUMENT your chart's props using TypeScript and JSDoc comments like below! */
 
diff --git a/src/components/SEO/stories/docs/quickit.md b/src/components/SEO/stories/docs/quickit.md
index 16a1f136..fb1d94fb 100644
--- a/src/components/SEO/stories/docs/quickit.md
+++ b/src/components/SEO/stories/docs/quickit.md
@@ -2,7 +2,7 @@ Add the `SEO` component to any page specified in the `pages/` directory of the G
 
 Most of the fields are filled in by other sources, like your Google Doc and package.json. (Usually, the fastest way is to copy the `SEO` component from one of the pages already in your project.)
 
-> **IMPORTANT:** 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.
+> **IMPORTANT:** 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.
 
 ```svelte
 <script>