You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+18-14Lines changed: 18 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -47,7 +47,7 @@ Run `npx @uniformdev/cli new` and pick `Next.js` -> `Component Starter Kit` from
47
47
> Make sure your API key has "Developer" role to be able to push content.
48
48
1.`npm install` to install dependencies
49
49
1. Run `npm run init` to initialize your project.
50
-
> This will push all content from disk (`.\content` folder) and your design settings (colors, fonts, borders, etc. for this default theme).
50
+
> This command uses `@uniformdev/csk-cli` to push all content from disk (`./content` folder), design settings (colors, fonts, borders, etc.), and publish the context manifest. If CSK variants are available, you'll be prompted to select which one to initialize.
51
51
52
52
### Step 2. Run locally in dev mode
53
53
@@ -66,7 +66,16 @@ This integration brings new parameter types for design and layout control via Un
66
66
67
67
The following scripts are created to facilitate sync of content between the `./content` folder and your project.
68
68
69
-
1. Run `npm run push:content` to push data from disk (see `./content`) to your Uniformproject.
69
+
### Complete Project Sync
70
+
71
+
1. Run `npm run init` to initialize/push everything (content, design extensions, and context manifest) to your Uniform project.
72
+
2. Run `npm run uniform:pull` to pull everything (content and design extensions) from your Uniform project to disk.
73
+
74
+
These commands use `@uniformdev/csk-cli` and handle the complete synchronization workflow. If CSK variants are available, you'll be prompted to select which one to sync.
75
+
76
+
### Granular Content Sync
77
+
78
+
1. Run `npm run push:content` to push data from disk (see `./content`) to your Uniform project.
70
79
1. Run `npm run pull:content` to pull data from your Uniform project to `./content` folder.
71
80
72
81
Alternatively you can use `npm run pull:content:dev` and `npm run push:content:dev` to pull and push developer-owned content to your local project. The scope of the developer-owned content is defined in the `uniform.config.dev.ts` file.
@@ -83,6 +92,7 @@ Whenever you add new **colors, dimensions, fonts, or borders**, your application
83
92
84
93
```sh
85
94
npm run pull:dex
95
+
npm run apply:dex
86
96
```
87
97
88
98
This command is automatically executed when running:
@@ -105,16 +115,10 @@ When modifying an **existing value**, your app will automatically fetch the upda
105
115
106
116
## 🎨 Working with Styles
107
117
108
-
If you prefer managing styles manually, you can modify the predefined configuration files located in the `styles/` directory:
109
-
110
-
-`styles/border.css`
111
-
-`styles/colors.css`
112
-
-`styles/dimensions.css`
113
-
-`styles/fonts.css`
114
-
115
-
After making changes, push the updated configuration using:
118
+
If you prefer managing styles manually, you can modify the predefined configuration files `dex.config.json`. After making changes, apply and push the updated configuration using:
116
119
117
120
```sh
121
+
npm run apply:dex
118
122
npm run push:dex
119
123
```
120
124
@@ -143,16 +147,16 @@ By default, the **Design Extension** includes two predefined groups:
143
147
-`button`
144
148
-`text`
145
149
146
-
### **Understanding `allowGroups.json`**
150
+
### **Understanding `allowGroups`**
147
151
148
-
When your project is still using the default configuration, the `allowGroups.json` file will be **empty**. However, if you add a custom group (e.g., `page`), it will be added to this file automatically.
152
+
When your project is still using the default configuration, the `allowGroups` field will be **empty**. However, if you add a custom group (e.g., `page`), it will be added to this field automatically.
149
153
150
154
#### **Example: Adding a Custom Group (Page)**
151
155
152
-
If you introduce a new group, such as `page`, the `allowGroups.json` file will be updated as follows:
156
+
If you introduce a new group, such as `page`, the `dex.config.json` file will be updated as follows:
0 commit comments