Skip to content

Docs: Interactivity API > Getting Started Guide - minor adjustments #52786

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
juanmaguitar merged 2 commits into from
Jul 20, 2023
Merged

Docs: Interactivity API > Getting Started Guide - minor adjustments #52786

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
689338e
minor adjustments
juanmaguitar Jul 20, 2023
bdca268
changed superior by later when speaking of versions
juanmaguitar Jul 20, 2023
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
Next Next commit
minor adjustments
  • Loading branch information
@juanmaguitar
juanmaguitar committed Jul 20, 2023
commit 689338ed9cd0b36d63de8851951b1a87a6cfa806
14 changes: 7 additions & 7 deletions packages/interactivity/docs/1-getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,31 +4,31 @@ To get started with the Interactivity API, you can follow this [**Quick Start Gu

## Quick Start Guide

### 1. Scaffold an interactive block
#### 1. Scaffold an interactive block

We can scaffold a WordPress plugin that registers an interactive block (using the Interactivity API) by using a [template](https://www.npmjs.com/package/@wordpress/create-block-interactive-template) with the `@wordpress/create-block` command.

```
npx @wordpress/create-block my-first-interactive-block --template @wordpress/create-block-interactive-template
```

### 2. Generate the build
#### 2. Generate the build

When the plugin folder is generated, we should launch the build process to get the final version of the interactive block that can be used from WordPress.

```
cd my-first-interactive-block && npm start
```

### 3. Use it in your WordPress installation
#### 3. Use it in your WordPress installation

If you have a local WordPress installation already running, you can launch the commands above inside the `plugins` folder of that installation. If not, you can use [`wp-now`](https://github.com/WordPress/playground-tools/tree/trunk/packages/wp-now) to launch a WordPress site with the plugin installed by executing from the generated folder (and from a different terminal window or tab) the following command

```
npx @wp-now/wp-now start
```

At this point you should be able to insert the "Example Interactive" block into any post, and see how it behaves in the frontend when published.
At this point you should be able to insert the "My First Interactive Block" block into any post, and see how it behaves in the frontend when published.

## Requirements of the Interactivity API

Expand All @@ -38,16 +38,16 @@ To start working with the Interactivity API you'll need to have a [proper WordPr
- Gutenberg 16.2 or superior
- Node.js

### A local WordPress installation
#### A local WordPress installation

You can use [the tools to set your local WordPress environment](https://developer.wordpress.org/block-editor/getting-started/devenv/#wordpress-development-site) you feel more comfortable with.

To get quickly started, [`wp-now`](https://www.npmjs.com/package/@wp-now/wp-now) is the easiest way to get a WordPress site up and running locally.

### Latest vesion of Gutenberg (v16.2 or superior)
#### Latest vesion of Gutenberg (v16.2 or superior)

The Interactivity API is currently only available as an experimental feature from Gutenberg 16.2, so you'll need to have the latest version of the Gutenberg plugin (or at least v16.2) installed and activated in your WordPress installation.

### Node
#### Node

Block development requires [Node](https://nodejs.org/en), so you'll need to have Node installed and running on your machine. Any version should work, but please check the minimum version requirements if you run into any issues with any of the Node.js tools used in WordPress development.