Add "Get started with create-block" doc to the Getting Started section #55373
Conversation
ndiego
requested review from
ajitbohra,
ryanwelcher,
juanmaguitar and
fabiankaegy
as code owners
|
Between this PR and #55372, I'm wondering how much we could remove from README files in It surely can be tackled (if not planned already) as a follow-up, I mostly wanted to flag it as a great way to send folks from these packages to higher-level onboarding docs. |
| @@ -0,0 +1,91 @@ | |||
| # Get started with create-block | |||
|
|
|||
| The [`@wordpress/create-block`](https://developer.wordpress.org/block-editor/reference-guides/packages/packages-create-block/) package is an officially supported tool for scaffolding a WordPress plugin that registers a block. It generates all the necessary code to start a project and integrates a modern JavaScript build setup (using [`wp-scripts`](https://developer.wordpress.org/block-editor/getting-started/devenv/get-started-with-wp-scripts.md)) with no configuration required. | |||
There was a problem hiding this comment.
Aside: there is also an integration with wp-env included in Create Block, but it isn't enabled by default. Folks can enable it with the --wp-env CLI param, or through external templates.
|
|
||
| These scripts can then be run using the command `npm run {script name}`. The two scripts you will use most often are `start` and `build` since they handle the build step. | ||
|
|
||
| When working on your block, use the `npm run start` command. This will start a development server and automatically rebuild the block whenever any code change is detected. |
There was a problem hiding this comment.
While it works to use npm run start, it's also possible to call npm start for convenience. I don't remember if the included form is being used to align with other npm commands so just sharing as a sidenote.
|
Love this effort! |
|
@gziolo i would hate to see the actual readme files of the packages get removed. These are what shows on NPM and what should in my opinion always be the source of truth for a package. |
I didn't say that:
My comment was about removing similar content not the file from the package and linking to the Block Editor Handbook instead. |
🤦 Sorry for the confusion :) |
Yeah, I agree. We can look at those next. I think the readme's for the packages could be slimmed down and really just focus on the technical documentation and link to the "Get started..." guides as needed. |
ndiego
changed the title
Fixes #54960
What?
This PR adds a getting started guide for
create-block. This package is one of the best tools for getting started with block development. Having a primer on the subject in the Getting Started section will help new developers get oriented.