From 569d7021cba67f8692f9d84ce8db9d6f5ebae098 Mon Sep 17 00:00:00 2001 From: Eric Liu Date: Thu, 8 Jul 2021 16:30:53 -0700 Subject: [PATCH] Improve documentation (#730) * docs: fix "no-op" typo * docs: add carbon-preprocess-svelte * docs: use lg size for outbound link to source code * docs: update copy * docs: default to white theme * docs(recursive-list): simplify copy * docs(recursive-list): simplify copy * docs: apply noGutter to installation code snippets --- docs/index.html | 2 +- docs/src/components/ComponentApi.svelte | 2 +- docs/src/pages/_layout.svelte | 5 +++++ docs/src/pages/components/CodeSnippet.svx | 4 ++-- docs/src/pages/components/CopyButton.svx | 4 ++-- docs/src/pages/components/RecursiveList.svx | 4 ++-- docs/src/pages/index.svelte | 20 ++++++++++++++++++-- docs/src/store.js | 2 +- 8 files changed, 32 insertions(+), 11 deletions(-) diff --git a/docs/index.html b/docs/index.html index ce0d084b..153bb52f 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,5 +1,5 @@ - + diff --git a/docs/src/components/ComponentApi.svelte b/docs/src/components/ComponentApi.svelte index 91d24fc0..495690b2 100644 --- a/docs/src/components/ComponentApi.svelte +++ b/docs/src/components/ComponentApi.svelte @@ -44,7 +44,7 @@

Source code: - + {component.filePath}

diff --git a/docs/src/pages/_layout.svelte b/docs/src/pages/_layout.svelte index 0946cf77..1a41c8f0 100644 --- a/docs/src/pages/_layout.svelte +++ b/docs/src/pages/_layout.svelte @@ -79,6 +79,11 @@ > Carbon Charts Svelte + + Carbon Preprocess Svelte + Resources Carbon Design System diff --git a/docs/src/pages/components/CodeSnippet.svx b/docs/src/pages/components/CodeSnippet.svx index fb23a124..42f237f3 100644 --- a/docs/src/pages/components/CodeSnippet.svx +++ b/docs/src/pages/components/CodeSnippet.svx @@ -31,7 +31,7 @@ This component uses the native, asynchronous [Clipboard API](https://developer.m Please note that the `clipboard.writeText` API is not supported in [IE 11 nor Safari iOS version 13.3 or lower](https://caniuse.com/mdn-api_clipboard_writetext). -You can override the default copy functionality with your own copy text implementation. See [Overriding copy functionality](#overriding-copy-functionality). +You can override the default copy functionality with your own implementation. See [Overriding copy functionality](#overriding-copy-functionality). ### Default (single-line) @@ -48,7 +48,7 @@ In this example, we use the open source module [clipboard-copy](https://github.c ### Preventing copy functionality -To prevent text from being copied entirely, pass a "noop" function to the `copy` prop. +To prevent text from being copied entirely, pass a no-op function to the `copy` prop. {}} /> diff --git a/docs/src/pages/components/CopyButton.svx b/docs/src/pages/components/CopyButton.svx index 2488795b..6b4ed10f 100644 --- a/docs/src/pages/components/CopyButton.svx +++ b/docs/src/pages/components/CopyButton.svx @@ -7,7 +7,7 @@ This component uses the native, asynchronous [Clipboard API](https://developer.m Please note that the `clipboard.writeText` API is not supported in [IE 11 nor Safari iOS version 13.3 or lower](https://caniuse.com/mdn-api_clipboard_writetext). -You can override the default copy functionality with your own copy text implementation. See [Overriding copy functionality](#overriding-copy-functionality). +You can override the default copy functionality with your own implementation. See [Overriding copy functionality](#overriding-copy-functionality). ### Default @@ -27,6 +27,6 @@ In this example, we use the open source module [clipboard-copy](https://github.c ### Preventing copy functionality -To prevent text from being copied entirely, pass a "noop" function to the `copy` prop. +To prevent text from being copied entirely, pass a no-op function to the `copy` prop. {}} /> \ No newline at end of file diff --git a/docs/src/pages/components/RecursiveList.svx b/docs/src/pages/components/RecursiveList.svx index 6212fbe1..8b6d7412 100644 --- a/docs/src/pages/components/RecursiveList.svx +++ b/docs/src/pages/components/RecursiveList.svx @@ -3,9 +3,9 @@ import Preview from "../../components/Preview.svelte"; -This component uses the [svelte:self API](https://svelte.dev/docs#svelte_self) to render the [UnorderedList](/components/UnorderedList) and [OrderedList](/components/OrderedList) components with data formatted as a tree structure. This is especially useful when the depth of the tree is unknown. +This component uses the [svelte:self API](https://svelte.dev/docs#svelte_self) to render the [UnorderedList](/components/UnorderedList) and [OrderedList](/components/OrderedList) components with tree structured data. -A child node can render text (`text`), a link (`href`), HTML content (`html`), and other `children`. +A child node can render text, a link, HTML content, and other children.
diff --git a/docs/src/pages/index.svelte b/docs/src/pages/index.svelte index a7d9560b..31365bbe 100644 --- a/docs/src/pages/index.svelte +++ b/docs/src/pages/index.svelte @@ -52,9 +52,13 @@

Install

Installing with yarn:

- + + +

Using npm:

- + + + @@ -90,6 +94,7 @@ + + + + + diff --git a/docs/src/store.js b/docs/src/store.js index f98338a3..8b2add48 100644 --- a/docs/src/store.js +++ b/docs/src/store.js @@ -1,3 +1,3 @@ import { writable } from "svelte/store"; -export const theme = writable("g100"); +export const theme = writable("white");