Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add docs for web-types #1608

Merged
merged 2 commits into from
Oct 12, 2023
Merged

add docs for web-types #1608

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
41703f8
add docs for web-types
break-stuff Oct 10, 2023
724a9d9
add missing word
break-stuff Oct 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 22 additions & 1 deletion docs/pages/getting-started/usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 editor 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

Expand Down