Skip to content
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

Adds a README.md file to the project scaffolded by create-block #53896

Open
wants to merge 2 commits into
base: trunk
Choose a base branch
from
Open

Adds a README.md file to the project scaffolded by create-block #53896

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cfe2578
Adds a README.md file to the project scaffolded by create-block
mburridge Aug 23, 2023
e9fa30c
Adds Learn section for dynamic block
mburridge Aug 23, 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
Prev Previous commit
Adds Learn section for dynamic block
  • Loading branch information
@mburridge
mburridge committed Aug 23, 2023
commit e9fa30c85d7a0fa8b572f0bc737150afed07220e
7 changes: 5 additions & 2 deletions packages/create-block/lib/templates/plugin/README.md.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,10 @@ Provides an overview of the project.
### readme.txt
If you intend to [publish](https://developer.wordpress.org/plugins/wordpress-org/) your project to the [WordPress Plugin Directory](https://wordpress.org/plugins/) a `readme.txt` file is required. The `readme.txt` file needs to be in a [certain format](https://developer.wordpress.org/plugins/wordpress-org/how-your-readme-txt-works/). This file provides a template that you can modify.

{{#isStaticVariant}}
## Learn Block Development
{{#isStaticVariant}}
For a progressive step-by-step tutorial on creating a static block check out [Introduction to Block Development: Build your first custom block](https://learn.wordpress.org/course/introduction-to-block-development-build-your-first-custom-block/)
{{/isStaticVariant}}
{{/isStaticVariant}}
{{#isDynamicVariant}}
To learn about creating a dynamic block check out [Creating dynamic blocks](https://developer.wordpress.org/block-editor/how-to-guides/block-tutorial/creating-dynamic-blocks/) and [Block Supports in dynamic blocks](https://developer.wordpress.org/block-editor/how-to-guides/block-tutorial/block-supports-in-dynamic-blocks/) in the Block Editor Handbook.
{{/isDynamicVariant}}
Loading