From e4413dceee7f4f13ccc8989ade5e78641eec495e Mon Sep 17 00:00:00 2001 From: Cory LaViska Date: Tue, 31 Aug 2021 07:37:41 -0400 Subject: [PATCH] update docs --- docs/getting-started/installation.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/docs/getting-started/installation.md b/docs/getting-started/installation.md index 826d6885c..c6000c11e 100644 --- a/docs/getting-started/installation.md +++ b/docs/getting-started/installation.md @@ -50,32 +50,34 @@ If you don't want to use the CDN, you can install Shoelace locally with the foll npm install @shoelace-style/shoelace ``` -It's up to you to make the source files available to your app. One way to do this is to create a route in your app called `/scripts/shoelace` that serves static files from `node_modules/@shoelace-style/shoelace`. +It's up to you to make the source files available to your app. One way to do this is to create a route in your app called `/shoelace` that serves static files from `node_modules/@shoelace-style/shoelace`. Once you've done that, add the following tags to your page. Make sure to update `href` and `src` so they point to the route you created. ```html - - + + ``` +Alternatively, [you can use a bundler](#bundling). + ?> For clarity, the docs will usually show imports from `@shoelace-style/shoelace`. If you're not using a module resolver or bundler, you'll need to adjust these paths to point to the folder Shoelace is in. ## Setting the Base Path Some components rely on assets (icons, images, etc.) and Shoelace needs to know where they're located. For convenience, Shoelace will try to auto-detect the correct location based on the script you've loaded it from. This assumes assets are colocated with `shoelace.js` and will "just work" for most users. -However, if you're [cherry picking](#cherry-picking) or [bundling](#bundling) Shoelace, you'll need to set the base path. You can do this one of two ways. The following example assumes you're serving Shoelace's `dist` directory from `/scripts/shoelace`. +However, if you're [cherry picking](#cherry-picking) or [bundling](#bundling) Shoelace, you'll need to set the base path. You can do this one of two ways. ```html - + ``` @@ -93,7 +95,7 @@ Here's an example that loads only the button component. Again, if you're not usi -