Skip to content

Commit

Permalink
Update docs and readme post merge of #35645 (#35679)
Browse files Browse the repository at this point in the history
* Update changelog to reflect changes in #35645.

* Remove unneeded word.

* Update readme to inlcude local template references and example.

* Fix indentation.
  • Loading branch information
ryanwelcher authored Oct 15, 2021
1 parent 5705c4b commit bae1030
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 3 deletions.
3 changes: 2 additions & 1 deletion packages/create-block/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
## Unreleased

### New Features
- Add `slugPascalCase` to the list of variables that can be used in templates ([#35462](https://github.com/WordPress/gutenberg/pull/35462))
- 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))

## 2.5.0 (2021-07-21)

Expand Down
10 changes: 8 additions & 2 deletions packages/create-block/README.md
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

0 comments on commit bae1030

Please sign in to comment.