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
+4-67Lines changed: 4 additions & 67 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -37,7 +37,7 @@ Out of the box, this template provides a minimal WordPress theme with basic supp
37
37
38
38
## Quickstart
39
39
40
-
This project requires [Docker][docker] and [Node.js][node] for local development. For a better editing experience for PHP and Twig files, it's useful to have [PHP installed][php-install] on your system as well. If you are on Windows and use VS Code, you may find it helpful to [run VS Code in a container][vs-code-container] so that you can more easily work with PHP (see more details in the [Local Development Setup section](#running-vs-code-in-a-container)).
40
+
This project requires [Docker][docker] and [Node.js][node] for local development. For a better editing experience for PHP and Twig files, it's useful to have [PHP installed][php-install] on your system as well, but it isn't required.
41
41
42
42
To run the project for the first time, do the following:
43
43
@@ -204,11 +204,11 @@ If you use [VS Code][vs-code], you can create a `settings.json` file inside a `.
204
204
205
205
We recommend these extensions to make working with PHP and Twig easier.
206
206
207
-
-[PHP Sniffer & Beautifier][phpsab-vscode]
207
+
-[PHP Sniffer & Beautifier][phpsab-vscode] (may not work on Windows)
208
208
-[Twig][twig-vscode]
209
-
-[twigcs][twigcs-vscode]
209
+
-[twigcs][twigcs-vscode] (may not work on Windows)
210
210
211
-
Note: you will need to have vendor files available on your host machine (not the container they're installed in) for the linters to highlight code while you're working. You can run `npm run map-vendor-files` to make them available at the paths specified in the example `settings.json` below, and as long as you have PHP installed on your system, they _should_ work. Windows has limited support for PHP, though, so you may want to run VS Code in a container so that PHP will be more easily available (or you can choose to live without real-time error highlighting).
211
+
Note: you will need to have vendor files available on your host machine (not the container they're installed in) for the linters to highlight code while you're working. You can run `npm run map-vendor-files` to make them available at the paths specified in the example `settings.json` below, and as long as you have PHP installed on your system, they _should_ work. Windows has limited support for PHP, though, so you may not be able to get real-time error highlighting on PHP/Twig files.
212
212
213
213
```json
214
214
{
@@ -225,62 +225,6 @@ Note: you will need to have vendor files available on your host machine (not the
225
225
}
226
226
```
227
227
228
-
##### Running VS Code in a Container
229
-
230
-
The [Dev Containers extension][dev-containers-vscode] allows you to run VS Code inside a container, giving you access to a consistent environment that you can configure to include the dependencies you need. For this project, we recommend an Ubuntu container with the same PHP version as in the [Dockerfile](./Dockerfile), the LTS version of Node.js, and Docker (docker-in-docker).
231
-
232
-
After installing the Dev Containers extension, you can manually create the container through the extension's UI, or you can add a configuration file at `.devcontainer/devcontainer.json`, like so:
233
-
234
-
```json
235
-
// For format details, see https://aka.ms/devcontainer.json. For config options, see the
// Features to add to the dev container. More info: https://containers.dev/features.
266
-
// "features": {},
267
-
268
-
// Use 'forwardPorts' to make a list of ports inside the container available locally.
269
-
// "forwardPorts": [],
270
-
271
-
// Use 'postCreateCommand' to run commands after the container is created.
272
-
// "postCreateCommand": "uname -a",
273
-
274
-
// Configure tool-specific properties.
275
-
// "customizations": {},
276
-
277
-
// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
278
-
// "remoteUser": "root"
279
-
}
280
-
```
281
-
282
-
Note: after restarting in the containerized VS Code, you will need to run `npm ci` and `docker compose build` again. You may also need to delete the `theme` and `plugins` folders so that the build process can recreate them with the right file permissions for the container.
283
-
284
228
## WordPress
285
229
286
230
### Upgrading WordPress
@@ -737,12 +681,8 @@ Deployment to Pantheon requires setting the following variables and secrets in G
0 commit comments