From 41703f82094b682142ab4cf94f9c576211f41d6c Mon Sep 17 00:00:00 2001 From: Burton Smith <burton@breakstuff.io> Date: Mon, 9 Oct 2023 20:55:29 -0400 Subject: [PATCH 1/2] add docs for web-types --- docs/pages/getting-started/usage.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/docs/pages/getting-started/usage.md b/docs/pages/getting-started/usage.md index 6cf1075d47..0ca2323c36 100644 --- a/docs/pages/getting-started/usage.md +++ b/docs/pages/getting-started/usage.md @@ -214,7 +214,28 @@ If `settings.json` already exists, simply add the above line to the root of the If you are using a [JetBrains IDE](https://www.jetbrains.com/) and you are installing Shoelace from NPM, the editor will automatically detect the `web-types.json` file from the package and you should immediately see component information in your editor. -If you are installing from the CDN, you can [download a local copy](https://cdn.jsdelivr.net/npm/@shoelace-style/shoelace/dist/web-types.json) and add it to the root of your project. +If you are installing from the CDN, you can [download a local copy](https://cdn.jsdelivr.net/npm/@shoelace-style/shoelace/dist/web-types.json) and add it to the root of your project. Be sure to add a reference to the `web-types.json` file in your `package.json` in order for your to properly detect it. + +```json +{ + ... + "web-types": "./web-types.json" + ... +} +``` + +If you are using types from multiple projects, you can add an array of references. + +```json +{ + ... + "web-types": [ + ..., + "./web-types.json" + ] + ... +} +``` ### Other Editors From 724a9d9ab0297efd9e915f1b09626d793a21fcf7 Mon Sep 17 00:00:00 2001 From: Burton Smith <burton@breakstuff.io> Date: Mon, 9 Oct 2023 21:06:08 -0400 Subject: [PATCH 2/2] add missing word --- docs/pages/getting-started/usage.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/pages/getting-started/usage.md b/docs/pages/getting-started/usage.md index 0ca2323c36..d7dac318b0 100644 --- a/docs/pages/getting-started/usage.md +++ b/docs/pages/getting-started/usage.md @@ -214,7 +214,7 @@ If `settings.json` already exists, simply add the above line to the root of the If you are using a [JetBrains IDE](https://www.jetbrains.com/) and you are installing Shoelace from NPM, the editor will automatically detect the `web-types.json` file from the package and you should immediately see component information in your editor. -If you are installing from the CDN, you can [download a local copy](https://cdn.jsdelivr.net/npm/@shoelace-style/shoelace/dist/web-types.json) and add it to the root of your project. Be sure to add a reference to the `web-types.json` file in your `package.json` in order for your to properly detect it. +If you are installing from the CDN, you can [download a local copy](https://cdn.jsdelivr.net/npm/@shoelace-style/shoelace/dist/web-types.json) and add it to the root of your project. Be sure to add a reference to the `web-types.json` file in your `package.json` in order for your editor to properly detect it. ```json {