Skip to content

Commit

Permalink
Docs(web): Add CDN links for quick usage of the spirit-web package
Browse files Browse the repository at this point in the history
  • Loading branch information
adamkudrna committed Oct 16, 2023
1 parent d8f2d10 commit 93577b2
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions packages/web/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,12 @@ Link the full, vendor-prefixed and minimised CSS with default Spirit branding
in your HTML template:

```html
<link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Inter:wght@400;600;700&display=swap" />
<link rel="stylesheet" href="node_modules/@lmc-eu/spirit-web/css/components.min.css" />
```

👉 Alternatively, you can use [CDN](#cdn) links when you don't want to install any npm packages.

### Advanced Implementation in Product with Sass

**Important:** Make sure you have
Expand Down Expand Up @@ -143,6 +146,20 @@ var modal = new Modal('#myModal');
var dropdown = new Dropdown('[data-spirit-toggle="dropdown"]');
```

### CDN

Spirit Design System is also available on CDN:

| Description | URL |
| --------------- | ----------------------------------------------------------------------------------------- |
| CSS: Foundation | https://cdn.jsdelivr.net/npm/@lmc-eu/spirit-web@latest/css/foundation.min.css |
| CSS: Components | https://cdn.jsdelivr.net/npm/@lmc-eu/spirit-web@latest/css/components.min.css |
| CSS: Helpers | https://cdn.jsdelivr.net/npm/@lmc-eu/spirit-web@latest/css/helpers.min.css |
| CSS: Utilities | https://cdn.jsdelivr.net/npm/@lmc-eu/spirit-web@latest/css/utilities.min.css |
| JavaScript | https://cdn.jsdelivr.net/npm/@lmc-eu/spirit-web@latest/js/bundle/spirit-web.bundle.min.js |

👉 Consider using a specific version instead of `latest` in production.

## Rebranding

Design tokens and their [`@tokens` API][tokens-api] enable quick and easy
Expand Down

0 comments on commit 93577b2

Please sign in to comment.