{"id":13461447,"url":"https://github.com/WordPress/gutenberg-examples","last_synced_at":"2025-03-24T22:34:41.933Z","repository":{"id":37708630,"uuid":"99146403","full_name":"WordPress/gutenberg-examples","owner":"WordPress","description":"Examples for extending WordPress/Gutenberg with blocks.","archived":false,"fork":false,"pushed_at":"2023-12-22T15:08:15.000Z","size":3623,"stargazers_count":1194,"open_issues_count":29,"forks_count":310,"subscribers_count":82,"default_branch":"trunk","last_synced_at":"2025-03-17T22:39:33.223Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/WordPress.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2017-08-02T18:00:17.000Z","updated_at":"2025-03-16T15:03:31.000Z","dependencies_parsed_at":"2023-12-22T16:14:03.603Z","dependency_job_id":null,"html_url":"https://github.com/WordPress/gutenberg-examples","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WordPress%2Fgutenberg-examples","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WordPress%2Fgutenberg-examples/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WordPress%2Fgutenberg-examples/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WordPress%2Fgutenberg-examples/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/WordPress","download_url":"https://codeload.github.com/WordPress/gutenberg-examples/tar.gz/refs/heads/trunk","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245366191,"owners_count":20603438,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-07-31T11:00:39.086Z","updated_at":"2025-03-24T22:34:41.461Z","avatar_url":"https://github.com/WordPress.png","language":"JavaScript","funding_links":[],"categories":["Gutenberg","Uncategorized"],"sub_categories":["Uncategorized"],"readme":"# Gutenberg Examples\n\n\u003ca href=\"https://github.com/WordPress/block-development-examples\"\u003e\u003cimg src=\"https://user-images.githubusercontent.com/422576/292488399-6dc23f79-b971-427d-af6b-f39db99955fd.png\" alt=\"Demo\"\u003e\u003c/a\u003e\n\n\u003c!-- \u003cp align=\"center\"\u003e\u003cimg src=\"https://user-images.githubusercontent.com/1039236/47116000-fd775000-d27d-11e8-9c46-761a90cb30a2.gif\" alt=\"Demo\"\u003e\u003c/p\u003e --\u003e\n\n\u003e **Warning**\n\u003e The repo https://github.com/WordPress/gutenberg-examples/ is no longer maintained. Please check **https://github.com/WordPress/block-development-examples** for examples of block development. Additionally, you can also check https://github.com/WordPress/block-theme-examples for examples of theme development.\n\n\u003c!--\n\nExamples for extending\n[Gutenberg](https://github.com/WordPress/gutenberg)\nwith plugins which create blocks.\n\nSee also:\n[Gutenberg developer documentation](https://wordpress.org/gutenberg/handbook/)\n\n## Installation\n\nGutenberg Examples are distributed as WordPress plugin.\n\n1. [Download the gutenberg-examples.zip archive of the latest release](https://github.com/WordPress/gutenberg-examples/releases).\n    \u003e Do not download from the \"Clone or download\" GitHub button, as this includes the source material only. Read the [Development](#development) instructions below if you’re interested in building your own copy of the plugin.\n2. Navigate to the **Plugins \u003e Add new** screen in your WordPress administrative dashboard.\n3. Click **Add New** at the top of the page.\n4. Click **Upload Plugin** at the top of the page.\n5. Click **Choose File**, then find and **Upload** the downloaded zip file.\n6. After the plugin finishes installing, click **Activate**.\n7. You’re done!\n\n## Development\n\nThis project uses the [`@wordpress/env`](https://developer.wordpress.org/block-editor/reference-guides/packages/packages-env/) package to provide a local development environment. Before you can use the development environment, you must install [Docker](https://docs.docker.com/get-docker/).\n\nOnce Docker is installed, clone this project and enter the working directory:\n\n```\ngit clone git@github.com:WordPress/gutenberg-examples.git\ncd gutenberg-examples\n```\n\nThen, install the project dependencies:\n\n```\nnpm install\n```\n\nOnce installed, start the local WordPress instance with one of two commands:\n\n1. `npm run env:start` - Starts the instance normally.\n2. `npm run env:start:debug` - Starts the instance with debugging enabled.\n\nThe WordPress instance will be available at http://localhost:8888/. You can login with the username and password \"admin\" and the password \"password\" at http://localhost:8888/wp-login.php. The plugin should be automatically activated.\n\nTo stop this local WordPress instance later run:\n\n```\nnpm run env:stop\n```\n\nTo install the node packages\n\n```\nnpm install\n```\n\nThis repository does not version the built files for any of the examples. You can build all of the examples by running `npm run build:all` in the project root.\n\n## Local Development\n\nIn this repository, there are block and non-block examples and each have their own build process.\n\nBlock examples are stored in the `blocks-jsx` and `blocks-non-jsx` directories while and other non-block examples are stored in the `non-block-examples` directory.\n\n\u003e **Note**\n\u003e The blocks stored in `blocks-non-jsx` do not use JSX and therefore do not require a build process\n\n#### Build and watch\n\n-   **`npm run start`** - Builds development versions of ALL the examples that require a build process (`blocks-jsx` and `non-block-examples`) and watches for changes to files to automatically rebuild as you develop.\n-   `npm run start:block` - Builds development versions of the examples at `blocks-jsx` folder and watches for changes to files to automatically rebuild as you develop.\n-   `npm run start:non-block` - Builds development versions of the examples at `non-block-examples` folder and watches for changes to files to automatically rebuild as you develop.\n\n\n#### Build\n\n-   **`npm run build`** - Generates production files for ALL the examples that require a build process (`blocks-jsx` and `non-block-examples`).\n-   `npm run build:block` - Generates production files for the examples at `blocks-jsx` folder.\n-   `npm run build:non-block` - Generates production files for the examples at `non-block-examples` folder.\n\n\u003cbr/\u003e\u003cbr/\u003e\u003cp align=\"center\"\u003e\u003cimg src=\"https://s.w.org/style/images/codeispoetry.png?1\" alt=\"Code is Poetry.\" /\u003e\u003c/p\u003e\n--\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FWordPress%2Fgutenberg-examples","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FWordPress%2Fgutenberg-examples","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FWordPress%2Fgutenberg-examples/lists"}