File tree 3 files changed +37
-16
lines changed
3 files changed +37
-16
lines changed Original file line number Diff line number Diff line change 62
62
- name : Sync files to S3 bucket
63
63
run : |
64
64
PACKAGE_VERSION=$(npm pkg get version --workspaces=false | tr -d \")
65
- aws s3 sync dist s3://cdn.zigurous.com/css-styles @$PACKAGE_VERSION/dist --delete
65
+ aws s3 sync dist s3://cdn.zigurous.com/forge-css @$PACKAGE_VERSION/dist --delete
Original file line number Diff line number Diff line change 1
- # @zigurous/css-styles
1
+ # Forge CSS
2
+
3
+ The official CSS implementation of the Forge design system created by [ @zigurous ] ( https://github.com/zigurous ) .
2
4
3
5
## Installation
4
6
5
- Add scoped package registry to ` .npmrc ` file
7
+ ### NPM
8
+
9
+ Set the scoped package registry in your ` .npmrc ` file:
6
10
``` bash
7
11
registry=https://registry.npmjs.org/
8
12
@zigurous:registry=https://npm.pkg.github.com
9
13
```
10
14
11
- Run one of the following commands in a terminal
12
- ``` bash
13
- npm install @zigurous/css-styles
14
- # or
15
- yarn add @zigurous/css-styles
16
- # or
17
- pnpm add @zigurous/css-styles
15
+ Run one of the following commands in a terminal:
16
+ - Install with npm ` npm install @zigurous/forge-css `
17
+ - Install with yarn ` yarn add @zigurous/forge-css `
18
+ - Install with pnpm ` pnpm add @zigurous/forge-css `
19
+
20
+ Import the css file in your code:
21
+ ``` js
22
+ import ' @zigurous/forge-css/dist/index.min.css'
23
+ ```
24
+
25
+ ### CDN
26
+
27
+ Add one of the following links to your HTML:
28
+
29
+ #### Cloudfront
30
+
31
+ ``` html
32
+ <
link href =
" https://cdn.zigurous.com/[email protected] /dist/index.min.css" rel =
" stylesheet" >
33
+ ```
34
+
35
+ #### jsDelivr
36
+
37
+ ``` html
38
+ <
link href =
" https://cdn.jsdelivr.net/gh/zigurous/[email protected] /dist/index.min.css" rel =
" stylesheet" >
18
39
```
19
40
20
- ## Usage
41
+ #### statically
21
42
22
- ``` jsx
23
- import ' @ zigurous/css-styles/ dist/index.min.css'
43
+ ``` html
44
+ < link href = " https://cdn.statically.io/gh/ zigurous/forge-css/1.0.0/ dist/index.min.css" rel = " stylesheet " >
24
45
```
Original file line number Diff line number Diff line change 1
1
{
2
- "name" : " @zigurous/css-styles " ,
3
- "version" : " 3 .0.0" ,
2
+ "name" : " @zigurous/forge-css " ,
3
+ "version" : " 1 .0.0" ,
4
4
"license" : " SEE LICENSE IN LICENSE" ,
5
- "repository" : " https://github.com/zigurous/css-styles " ,
5
+ "repository" : " https://github.com/zigurous/forge-css " ,
6
6
"devDependencies" : {
7
7
"husky" : " ^9.1.6" ,
8
8
"lightningcss-cli" : " ^1.27.0"
You can’t perform that action at this time.
0 commit comments