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
{{ message }}
This repository was archived by the owner on Jun 1, 2023. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+31-7Lines changed: 31 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -244,31 +244,55 @@ jobs:
244
244
```
245
245
246
246
## Development
247
+
247
248
### Web Assets
248
249
249
-
To make changes to the CSS files, you need to have Node and a package manager such as `npm` installed. To get started:
250
+
CSS assets used by the HTML output format
251
+
are processed and generated by [PostCSS](https://postcss.org).
252
+
To make changes to these assets,
253
+
you'll need to have [Node.js](https://nodejs.org/en/)
254
+
and a package manager, such as [`npm`](https://www.npmjs.com),
255
+
installed on your machine.
256
+
257
+
Navigate to the `.node` directory
258
+
and run `npm install` to download the required tools and libraries.
250
259
251
260
```terminal
252
261
$ cd .node
253
262
$ npm install
254
263
```
255
264
256
-
To process the PostCSS files during development:
265
+
> **Note**:
266
+
> `package.json` is located at a hidden `.node` subdirectory
267
+
> to prevent Xcode from displaying or indexing the contents of `node_modules`
268
+
> when opening the main project.
269
+
270
+
From the `.node` directory,
271
+
run the `watch` script
272
+
to start watching for changes to files in the `Assets` folder.
273
+
Whenever an asset source file is added, removed, or updated,
274
+
its corresponding (unoptimized) product is automatically generated
275
+
in the `Resouces` folder.
257
276
258
277
```terminal
259
-
$ cd .node
260
278
$ npm run watch
261
279
```
262
280
263
-
This will start watching the source files in `Assets` with hot-reload support, auto-generating non-optimized assets in `Resources` whenever a source file is saved.
264
-
265
-
Once happy with the results, run this command to create production-ready assets:
281
+
When you're happy with the results,
282
+
run the `build` script to generate production-ready assets.
266
283
267
284
```terminal
268
285
$ npm run build
269
286
```
270
287
271
-
Both the source files and the generated files are checked into this repository.
288
+
Finally,
289
+
commit any changes to the source files in `Assets`
0 commit comments