wires/hypnagaga
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

add component docs to new component template per #18

Browse source
This commit is contained in:
Jon McClure 2022-08-26 16:14:27 +01:00
parent 9316af81d3
commit 2657a77a56
2 changed files with 6 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
bin/newComponent/template/YourComponent/YourComponent.svelte
View file

@ -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! */

2
src/components/SEO/stories/docs/quickit.md
View file

@ -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>