Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ slug: /developers/local-development/wp-now
---

:::caution Package deprecated
The NPM package @wp-now/wp-now is deprecated, won't receive updates in the future. To use a command-line tool on your developer flow, use the NPM package `@wp-playground/cli`.
The NPM package @wp-now/wp-now is deprecated and won't receive updates in the future. To use a command-line tool in your developer workflow, use the NPM package `@wp-playground/cli`.
:::

# wp-now NPM package
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ npx @wp-playground/cli@latest server --mount-before-install=.:/wordpress/
```

:::info
On Windows, the path format `/host/path:/vfs/path` can cause issues. To resolve this, use the flags `--mount-dir` and `--mount-dir-before-install`. These flags let you specify host and virtual file system paths in an alternative format`"/host/path"` `"/vfs/path"`.
On Windows, the path format `/host/path:/vfs/path` can cause issues. To resolve this, use the flags `--mount-dir` and `--mount-dir-before-install`. These flags let you specify host and virtual file system paths in an alternative format: `"/host/path"` `"/vfs/path"`.
:::

### Understanding Data Persistence and SQLite Location
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Playground offers various development environments to streamline setting up and

For a quick start, use a [public Playground web instance](/web-instance) at https://playground.wordpress.net/. Alternatively, you can [host your own WordPress Playground](/developers/architecture/host-your-own-playground).

Playground also provides tools for local WordPress development, prioritizing easy installation and usability:
Playground also provides tools for local WordPress development, prioritizing ease of installation and usability:

- **[@wp-playground/cli](/developers/local-development/wp-playground-cli):** A command-line tool to quickly launch a WordPress site from your terminal.
- **[Visual Studio Code Extension](/developers/local-development/vscode-extension):** Integrates WordPress development directly into VS Code for a seamless experience within the popular editor.
Expand Down
2 changes: 1 addition & 1 deletion packages/docs/site/docs/developers/06-apis/01-index.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ Blueprints play a significant role in WordPress Playground, so they have their o

### JavaScript API

The `@wp-playground/client` package provides a JavaScript API you can use to fully control your Playground instance. Here's a very example of what you can do:
The `@wp-playground/client` package provides a JavaScript API you can use to fully control your Playground instance. Here's a simple example of what you can do:

import JSApiShortExample from '@site/docs/\_fragments/\_js_api_short_example.mdx';

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ First, Xdebug is present in two different CLIs:
- **`@php-wasm/cli`**: Run standalone PHP scripts. Use this when debugging PHP code without needing a WordPress environment.
- **`@wp-playground/cli`**: Run a full WordPress installation. Useful for debugging WordPress plugins, themes, or core functionality.

For this guide, we'll use `@wp-playground/cli`. Suppose you're not familiar with the tool. In that case, we recommend reading the [`@wp-playground/cli` guide](/developers/local-development/wp-playground-cli), but the same process can also be applied to debugging PHP applications with `@php-wasm/cli`.
For this guide, we'll use `@wp-playground/cli`. If you're not familiar with the tool, we recommend reading the [`@wp-playground/cli` guide](/developers/local-development/wp-playground-cli), but the same process can also be applied to debugging PHP applications with `@php-wasm/cli`.

## Quick start with `npx`

Expand All @@ -25,7 +25,7 @@ The fastest way to get started is using npx, which doesn't require installation:
npx @wp-playground/cli@latest server --xdebug
```

This starts WordPress on `http://127.0.0.1:9400` with Xdebug enabled. Now you connect a debugger.
This starts WordPress on `http://127.0.0.1:9400` with Xdebug enabled. Now you can connect a debugger.

:::info
Only one project can be debugged at a time.
Expand Down Expand Up @@ -118,7 +118,7 @@ If everything is ready, you run the command:
```bash
npx @wp-playground/cli@latest server --xdebug --experimental-unsafe-ide-integration=vscode --auto-mount
```
If you don't have a ´.vscode/launch.json´ file, the terminal will create a file similar to this:
If you don't have a `.vscode/launch.json` file, the terminal will create a file similar to this:

```JSON
{
Expand Down
2 changes: 1 addition & 1 deletion packages/docs/site/docs/developers/intro-devs.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Hi! Welcome to WordPress Playground Developer documentation.

- [**Documentation**](/) – Introduction to WP Playground, starter guides and your entry point to WP Playground Docs.
- [**Blueprints**](/blueprints) – Blueprints are JSON files for setting up your WordPress Playground instance. Learn about their possibilities from the Blueprints docs hub.
- 👉 [**Developers**](/developers) (you're here)– WordPress Playground was created as a programmable tool. Discover all the things you can do with it from your code in this Developers docs hub.
- 👉 [**Developers**](/developers) (you're here) – WordPress Playground was created as a programmable tool. Discover all the things you can do with it from your code in this Developers docs hub.
- [**API Reference**](/api) – All the APIs exposed by WordPress Playground

## Navigating the Developers documentation hub
Expand Down
3 changes: 2 additions & 1 deletion packages/docs/site/docs/main/about/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ WordPress Playground is your place to build, test, and launch:

### Try themes and plugins on the fly

With the WordPress Playground, you can explore any [theme](https://developer.wordpress.org/themes/getting-started/what-is-a-theme/). You can choose from a wide range of themes and see how they look on your site. You can also modify the colors, fonts, layouts, and other visual elements to create a unique design. \
With WordPress Playground, you can explore any [theme](https://developer.wordpress.org/themes/getting-started/what-is-a-theme/). You can choose from a wide range of themes and see how they look on your site. You can also modify the colors, fonts, layouts, and other visual elements to create a unique design.

In addition to themes, you can experiment with plugins too. With WordPress Playground, you can install and test different plugins to see how they work and what they can do for your site. This allows you to explore and understand the capabilities of WordPress without worrying about breaking anything.

### Create content on the go
Expand Down
2 changes: 1 addition & 1 deletion packages/docs/site/docs/main/contributing/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Would you like to see the documentation in your language? Check the [Translation

If you are familiar with markdown, you can [fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo) the `wordpress-playground` repo and propose changes and new documentation pages by submitting a Pull Request.

The process of creating a branch to open new PRs with translated pages on the [WordPress/wordpress-playground](https://github.com/WordPress/wordpress-playground) repository is the same than contributing to other WordPress repositories such as gutenberg:
The process of creating a branch to open new PRs with translated pages on the [WordPress/wordpress-playground](https://github.com/WordPress/wordpress-playground) repository is the same as contributing to other WordPress repositories such as Gutenberg:
https://developer.wordpress.org/block-editor/contributors/code/git-workflow/

The documentation files (`.md` files) are stored in Playground's GitHub repository, [under `/packages/docs/site/docs`](https://github.com/WordPress/wordpress-playground/tree/trunk/packages/docs/site/docs) for English and [`/packages/docs/site/i18n`](https://github.com/WordPress/wordpress-playground/tree/trunk/packages/docs/site/i18n) for other languages.
Expand Down
10 changes: 5 additions & 5 deletions packages/docs/site/docs/main/web-instance.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,9 @@ Once you click on save, an instance will be stored with a generated name to be r
![Additional actions Menu](@site/static/img/about/playground-manager-additional-actions.webp)

- **Export Pull Request to GitHub**: This option allows you to export WordPress plugins, themes, and entire wp-content directories as pull requests to any public GitHub repository. Check [here](https://www.youtube.com/watch?v=gKrij8V3nK0&t=2488s) a demo of using this option.
- **Download as zip**: It creates a `.zip` with the setup of the Playground instance, including any themes or plugins installed. This `.zip` won't include content and database changes.
- **Report error**: If you have any issues with WP Playground, you can report it using the form available from this option. You can help resolve issues with Playground by sharing the error details with the development team behind Playground.
- **View Blueprint**: This option will open the current blueprint used for the Playground instance in the [Blueprints Builder tool](https://playground.wordpress.net/builder/builder.html). From this tool you'll be able to edit the blueprint online and run a new Playground instance with your edited version of the blueprint.
- **Download as .zip**: Creates a `.zip` file with the setup of the Playground instance, including any themes or plugins installed. This `.zip` won't include content and database changes.
- **Report error**: If you have any issues with WordPress Playground, you can report them using the form available from this option. You can help resolve issues with Playground by sharing the error details with the development team behind Playground.
- **View Blueprint**: This option will open the current blueprint used for the Playground instance in the [Blueprints Builder tool](https://playground.wordpress.net/builder/builder.html). From this tool, you'll be able to edit the blueprint online and run a new Playground instance with your edited version of the blueprint.

<span id="edit-the-blueprint"></span>

Expand All @@ -66,8 +66,8 @@ Once you click on save, an instance will be stored with a generated name to be r

![Import actions Menu](@site/static/img/about/playground-manager-import-actions.webp)

- **Import from zip**: It allows you to recreate a Playground instance using any `.zip` generated with the "Download as zip" option.
- **Preview a Gutenberg PR**: Allow testers run branches from the Gutenberg repository to test pull requests instantly.
- **Import from .zip**: Allows you to recreate a Playground instance using any `.zip` file generated with the "Download as .zip" option.
- **Preview a Gutenberg PR**: Allows testers to run branches from the Gutenberg repository to test pull requests instantly.
- **Import from GitHub**: This option allows you to import plugins, themes, and wp-content directories directly from your public GitHub repositories. To enable this feature, connect your GitHub account with WordPress Playground.

:::caution
Expand Down
Loading