Skip to content

Commit

Permalink
patch up docs links
Browse files Browse the repository at this point in the history
  • Loading branch information
hobbes7878 committed Nov 19, 2024
1 parent aaaa257 commit 886631f
Show file tree
Hide file tree
Showing 38 changed files with 38 additions and 35 deletions.
2 changes: 1 addition & 1 deletion src/components/AdSlot/InlineAd.svelte
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!-- @component `InlineAd` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/components-InlineAd--default) -->
<!-- @component `InlineAd` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/components-ads-analytics-inlinead--docs) -->
<script lang="ts">
import Block from '../Block/Block.svelte';
import type { InlineAd } from './@types/ads';
Expand Down
2 changes: 1 addition & 1 deletion src/components/AdSlot/LeaderboardAd.svelte
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!-- @component `LeaderboardAd` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/components-LeaderboardAd--default) -->
<!-- @component `LeaderboardAd` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/components-ads-analytics-leaderboardad--docs) -->
<script lang="ts">
import type { LeaderboardAd } from './@types/ads';
import ResponsiveAd from './ResponsiveAd.svelte';
Expand Down
2 changes: 1 addition & 1 deletion src/components/AdSlot/SponsorshipAd.svelte
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!-- @component `SponsorshipAd` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/components-SponsorshipAd--default) -->
<!-- @component `SponsorshipAd` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/components-ads-analytics-sponsorshipad--docs) -->
<script lang="ts">
import Block from '../Block/Block.svelte';
import type { SponsorshipAd } from './@types/ads';
Expand Down
2 changes: 1 addition & 1 deletion src/components/Analytics/Analytics.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
}
</script>

<!-- @component `Analytics` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/components-Analytics--default) -->
<!-- @component `Analytics` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/components-ads-analytics-analytics--docs) -->
<script lang="ts">
interface Author {
name: string;
Expand Down
2 changes: 1 addition & 1 deletion src/components/Article/Article.svelte
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!-- @component `Article` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/layout-article--default) -->
<!-- @component `Article` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/components-page-layout-article--docs) -->
<script lang="ts">
/** Set to true for embeddables. */
export let embedded: boolean = false;
Expand Down
2 changes: 1 addition & 1 deletion src/components/BeforeAfter/BeforeAfter.svelte
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!-- @component `BeforeAfter` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/components-beforeafter--default) -->
<!-- @component `BeforeAfter` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/components-graphics-beforeafter--docs) -->
<script lang="ts">
import { throttle } from 'lodash-es';
import { onMount } from 'svelte';
Expand Down
2 changes: 1 addition & 1 deletion src/components/Block/Block.svelte
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!-- @component `Block` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/layout-block--default) -->
<!-- @component `Block` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/components-page-layout-block--docs) -->
<script lang="ts">
import type { ContainerWidth } from '../@types/global';
Expand Down
2 changes: 1 addition & 1 deletion src/components/BodyText/BodyText.svelte
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!-- @component `BodyText` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/components-bodytext--default) -->
<!-- @component `BodyText` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/components-text-elements-bodytext--docs) -->
<script lang="ts">
import Markdown from '../Markdown/Markdown.svelte';
/**
Expand Down
1 change: 1 addition & 0 deletions src/components/Byline/Byline.svelte
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
<!-- @component `Byline` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/components-text-elements-byline--docs) -->
<script lang="ts">
import Block from '../Block/Block.svelte';
import slugify from 'slugify';
Expand Down
2 changes: 1 addition & 1 deletion src/components/DatawrapperChart/DatawrapperChart.svelte
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!-- @component `DatawrapperChart` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/components-DatawrapperChart--default) -->
<!-- @component `DatawrapperChart` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/components-graphics-datawrapperchart--docs) -->
<script lang="ts">
import { onMount, onDestroy } from 'svelte';
import GraphicBlock from '../GraphicBlock/GraphicBlock.svelte';
Expand Down
2 changes: 1 addition & 1 deletion src/components/DocumentCloud/DocumentCloud.svelte
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!-- @component `DocumentCloud` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/components-DocumentCloud--default) -->
<!-- @component `DocumentCloud` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/components-multimedia-documentcloud--docs) -->
<script lang="ts">
import type { ContainerWidth } from '../@types/global';
/** ✏️ DOCUMENT your chart's props using TypeScript and JSDoc comments like below! */
Expand Down
2 changes: 1 addition & 1 deletion src/components/EndNotes/EndNotes.svelte
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!-- @component `EndNotes` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/components-EndNotes--default) -->
<!-- @component `EndNotes` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/components-text-elements-endnotes--docs) -->
<script lang="ts">
interface EndNote {
/**
Expand Down
2 changes: 1 addition & 1 deletion src/components/FeaturePhoto/FeaturePhoto.svelte
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!-- @component `FeaturePhoto` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/components-FeaturePhoto--default) -->
<!-- @component `FeaturePhoto` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/components-multimedia-featurephoto--docs) -->
<script lang="ts">
import { onMount } from 'svelte';
import Block from '../Block/Block.svelte';
Expand Down
2 changes: 1 addition & 1 deletion src/components/GraphicBlock/GraphicBlock.svelte
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!-- @component `GraphicBlock` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/components-GraphicBlock--default) -->
<!-- @component `GraphicBlock` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/components-graphics-graphicblock--docs) -->
<script lang="ts">
import type { ContainerWidth } from '../@types/global';
Expand Down
2 changes: 1 addition & 1 deletion src/components/Headline/Headline.svelte
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!-- @component `Headline` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/components-Headline--default) -->
<!-- @component `Headline` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/components-text-elements-headline--docs) -->
<script lang="ts">
import type { HeadlineSize } from './../@types/global';
Expand Down
2 changes: 1 addition & 1 deletion src/components/HeroHeadline/Hero.svelte
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!-- @component `HeroHeadline` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/components-HeroHeadline--default) -->
<!-- @component `HeroHeadline` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/components-text-elements-heroheadline--docs) -->
<script lang="ts">
import type { HeadlineSize } from '../@types/global';
Expand Down
2 changes: 1 addition & 1 deletion src/components/InfoBox/InfoBox.svelte
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!-- @component `EndNotes` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/components-InfoBox--default) -->
<!-- @component `InfoBox` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/components-text-elements-infobox--docs) -->
<script lang="ts">
import type { ContainerWidth } from '../@types/global';
Expand Down
2 changes: 1 addition & 1 deletion src/components/Markdown/Markdown.svelte
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!-- @component `Markdown` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/components-Markdown--default) -->
<!-- @component `Markdown` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/components-text-elements-markdown--docs) -->
<script lang="ts">
import type { Action } from 'svelte/action';
import { marked } from 'marked';
Expand Down
1 change: 1 addition & 0 deletions src/components/PaddingReset/PaddingReset.svelte
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
<!-- @component `PaddingReset` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/components-page-layout-paddingreset--docs) -->
<script>
/**
* If parent container is fluid, which resets the padding around contained elements.
Expand Down
2 changes: 1 addition & 1 deletion src/components/PhotoCarousel/PhotoCarousel.svelte
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!-- @component `PhotoCarousel` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/components-PhotoCarousel--default) -->
<!-- @component `PhotoCarousel` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/components-multimedia-photocarousel--docs) -->
<script lang="ts">
type ContainerWidth = 'normal' | 'wide' | 'wider' | 'widest' | 'fluid';
Expand Down
2 changes: 1 addition & 1 deletion src/components/PhotoPack/PhotoPack.svelte
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!-- @component `PhotoPack` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/components-PhotoPack--default) -->
<!-- @component `PhotoPack` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/components-multimedia-photopack--docs) -->
<script lang="ts">
interface Image {
src: string;
Expand Down
2 changes: 1 addition & 1 deletion src/components/PymChild/PymChild.svelte
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!-- @component `PymChild` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/utilities-PymChild--default) -->
<!-- @component `PymChild` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/components-utilities-pymchild--docs) -->
<script lang="ts">
/** Pym.js polling interval */
export let polling: number = 500;
Expand Down
2 changes: 1 addition & 1 deletion src/components/ReferralBlock/ReferralBlock.svelte
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!-- @component `ReferralBlock` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/components-ReferralBlock--default) -->
<!-- @component `ReferralBlock` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/components-page-furniture-referralblock--docs) -->
<script lang="ts">
/** ✏️ DOCUMENT your chart's props using TypeScript and JSDoc comments like below! */
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!-- @component `ReutersGraphicsLogo` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/components-ReutersGraphicsLogo--default) -->
<!-- @component `ReutersGraphicsLogo` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/components-logos-reutersgraphicslogo--docs) -->
<script lang="ts">
/** "Kinesis" colour */
export let logoColour: string = '#FA6400';
Expand Down
2 changes: 1 addition & 1 deletion src/components/ReutersLogo/ReutersLogo.svelte
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!-- @component `ReutersLogo` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/components-ReutersLogo--default) -->
<!-- @component `ReutersLogo` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/components-logos-reuterslogo--docs) -->
<script lang="ts">
/** "Kinesis" colour */
export let logoColour: string = '#FA6400';
Expand Down
2 changes: 1 addition & 1 deletion src/components/SEO/SEO.svelte
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!-- @component `SEO` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/components-SEO--default) -->
<!-- @component `SEO` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/components-ads-analytic-seo--docs) -->
<script lang="ts">
/**
* Base url for the page, which in [Vite-based projects](https://vitejs.dev/guide/build.html#public-base-path)
Expand Down
2 changes: 1 addition & 1 deletion src/components/Scroller/Scroller.svelte
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!-- @component `Scroller` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/components-Scroller--default) -->
<!-- @component `Scroller` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/components-graphics-scroller--docs) -->
<script lang="ts">
import type { ContainerWidth, ScrollerStep } from '../@types/global';
Expand Down
2 changes: 1 addition & 1 deletion src/components/SearchInput/SearchInput.svelte
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!-- @component `SearchInput` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/components-SearchInput--default) -->
<!-- @component `SearchInput` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/components-controls-searchinput--docs) -->
<script lang="ts">
import { createEventDispatcher } from 'svelte';
import MagnifyingGlass from './MagnifyingGlass.svelte';
Expand Down
2 changes: 1 addition & 1 deletion src/components/SimpleTimeline/SimpleTimeline.svelte
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!-- @component `SimpleTimeline` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/components-SimpleTimeline--default) -->
<!-- @component `SimpleTimeline` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/components-text-elements-simpletimeline--docs) -->
<script lang="ts">
interface Event {
title: string;
Expand Down
2 changes: 1 addition & 1 deletion src/components/SiteFooter/SiteFooter.svelte
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!-- @component `SiteFooter` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/components-SiteFooter--default) -->
<!-- @component `SiteFooter` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/components-page-furniture-sitefooter--docs) -->
<script lang="ts">
import QuickLinks from './QuickLinks.svelte';
import CompanyLinks from './CompanyLinks.svelte';
Expand Down
2 changes: 1 addition & 1 deletion src/components/SiteHeader/SiteHeader.svelte
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!-- @component `SiteHeader` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/components-SiteHeader--default) -->
<!-- @component `SiteHeader` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/components-page-furniture-siteheader--docs) -->
<script lang="ts">
import ReutersLogo from '../ReutersLogo/ReutersLogo.svelte';
import NavBar from './NavBar/index.svelte';
Expand Down
1 change: 1 addition & 0 deletions src/components/SiteHeadline/SiteHeadline.svelte
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
<!-- @component `SiteHeadline` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/components-text-elements-siteheadline--docs) -->
<script lang="ts">
/**
* Used to set headline class fluid size from text-2xl to text-4xl
Expand Down
2 changes: 1 addition & 1 deletion src/components/Spinner/Spinner.svelte
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!-- @component `Spinner` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/components-Spinner--default) -->
<!-- @component `Spinner` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/components-utilities-spinner--docs) -->
<script lang="ts">
/** Primary colour of the spinner. */
export let colour: string = '#666';
Expand Down
2 changes: 1 addition & 1 deletion src/components/Table/Table.svelte
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!-- @component `Table` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/components-Table--default) -->
<!-- @component `Table` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/components-text-elements-table--docs) -->
<script lang="ts">
import { onMount } from 'svelte';
Expand Down
2 changes: 1 addition & 1 deletion src/components/Theme/Theme.svelte
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!-- @component `Theme` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/theming-Theme--default) -->
<!-- @component `Theme` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/components-theming-theme--docs) -->
<script context="module" lang="ts">
import light from './themes/light.js';
import dark from './themes/dark.js';
Expand Down
2 changes: 1 addition & 1 deletion src/components/ToolsHeader/ToolsHeader.svelte
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!-- @component `ToolsHeader` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/components-ToolsHeader--default) -->
<!-- @component `ToolsHeader` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/components-page-furniture-toolsheader--docs) -->
<script lang="ts">
/** Add an ID to target with SCSS. */
export let id: string = '';
Expand Down
2 changes: 1 addition & 1 deletion src/components/Video/Video.svelte
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!-- @component `Video` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/components-Video--default) -->
<!-- @component `Video` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/components-multimedia-video--docs) -->
<script lang="ts">
import IntersectionObserver from 'svelte-intersection-observer';
import Controls from './Controls.svelte';
Expand Down
2 changes: 1 addition & 1 deletion src/components/Visible/Visible.svelte
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!-- @component `Visible` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/components-Visible--default) -->
<!-- @component `Visible` [Read the docs.](https://reuters-graphics.github.io/graphics-components/?path=/docs/components-utilities-visible--docs) -->
<script lang="ts">
import { onMount } from 'svelte';
/**
Expand Down

0 comments on commit 886631f

Please sign in to comment.