From 59c02c9a92f91f396e53d1d42aab9ade8828cfca Mon Sep 17 00:00:00 2001 From: metonym Date: Mon, 3 Oct 2022 20:32:48 -0700 Subject: [PATCH] docs: update README, links (#1509) * docs: add note on using `optimizeImports` with `svelte-preprocess` (Closes #1500) * docs: point link to SASS guide to v10 (#1489) * docs: remove note on minimum Svelte version as it's been almost half a year since 3.48 was released --- README.md | 19 ++++++++++++++++--- docs/src/pages/index.svelte | 10 +--------- 2 files changed, 17 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 562c7660..b40fead3 100644 --- a/README.md +++ b/README.md @@ -31,8 +31,6 @@ Other forms of documentation are auto-generated: Install `carbon-components-svelte` as a development dependency. -A minimum Svelte version of 3.48.0 is required to use this library. - ```sh # Yarn yarn add -D carbon-components-svelte @@ -200,7 +198,7 @@ The preprocessor optimizes imports from the following packages: - [carbon-icons-svelte](https://github.com/carbon-design-system/carbon-icons-svelte) - [carbon-pictograms-svelte](https://github.com/carbon-design-system/carbon-pictograms-svelte) -**Example** +**Before & After** ```diff - import { Button } from "carbon-components-svelte"; @@ -222,6 +220,21 @@ export default { }; ``` +`svelte-preprocess` should be invoked before any preprocessor from `carbon-preprocess-svelte`. + +```diff +// svelte.config.js ++ import sveltePreprocess from "svelte-preprocess"; +import { optimizeImports } from "carbon-preprocess-svelte"; + +export default { + preprocess: [ ++ sveltePreprocess(), + optimizeImports() + ], +}; +``` + ## Examples - [examples/rollup](examples/rollup/) diff --git a/docs/src/pages/index.svelte b/docs/src/pages/index.svelte index 2c7ab5b1..258f4aaa 100644 --- a/docs/src/pages/index.svelte +++ b/docs/src/pages/index.svelte @@ -12,7 +12,6 @@ OutboundLink, RadioButtonGroup, RadioButton, - InlineNotification, } from "carbon-components-svelte"; import TileCard from "../components/TileCard.svelte"; import { theme } from "../store"; @@ -92,13 +91,6 @@

Installation

-
@@ -208,7 +200,7 @@ official Carbon guide on SASS