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

Update docs and readme post merge of #35645 #35679

Merged
merged 4 commits into from
Oct 15, 2021
Merged

Update docs and readme post merge of #35645 #35679

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ec29c70
Update changelog to reflect changes in #35645.
ryanwelcher Oct 15, 2021
9679479
Remove unneeded word.
ryanwelcher Oct 15, 2021
2815c6e
Update readme to inlcude local template references and example.
ryanwelcher Oct 15, 2021
d47d7e9
Fix indentation.
ryanwelcher Oct 15, 2021
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
1 change: 1 addition & 0 deletions packages/create-block/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
## Unreleased

### New Features
- Add passing local directories to --template. ([#35645](https://github.com/WordPress/gutenberg/pull/35645))
- Add `slugPascalCase` to the list of variables that can be used in templates ([#35462](https://github.com/WordPress/gutenberg/pull/35462))
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we correct the indentation of this line below to also be 4 spaces?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated. Looks like my IDE got me :)


## 2.5.0 (2021-07-21)
Expand Down
10 changes: 8 additions & 2 deletions packages/create-block/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Options:

```bash
-V, --version output the version number
-t, --template <name> block template type name, allowed values: "es5", "esnext", or the name of an external npm package (default: "esnext")
-t, --template <name> block template type name, allowed values: "es5", "esnext", the name of an external npm package (default: "esnext"), or the path to a local directory.
--namespace <value> internal namespace for the block name
--title <value> display title for the block
--short-description <value> short description for the block
Expand All @@ -65,7 +65,13 @@ $ npx @wordpress/create-block
$ npx @wordpress/create-block --template es5
```

3. Help – you need to use `npx` to output usage information.
3. Local template directory – it is also possible to pick a local directory as a template.

```bash
$ npx @wordpress/create-block --template ./path/to/template
```

4. Help – you need to use `npx` to output usage information.

```bash
$ npx @wordpress/create-block --help
Expand Down