Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
youknowriad committed Dec 17, 2019
1 parent 6f4bd22 commit 6708224
Show file tree
Hide file tree
Showing 4 changed files with 43 additions and 0 deletions.
1 change: 1 addition & 0 deletions bin/update-readmes.js
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ const packages = [
'escape-html',
'html-entities',
'i18n',
'keyboard-shortcuts',
'keycodes',
'plugins',
'priority-queue',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -892,6 +892,14 @@ _Returns_

- `Object`: Action object.

<a name="duplicateBlocks" href="#duplicateBlocks">#</a> **duplicateBlocks**

Generator that triggers an action used to duplicate a list of blocks.

_Parameters_

- _clientIds_ `Array<string>`:

<a name="enterFormattedText" href="#enterFormattedText">#</a> **enterFormattedText**

Returns an action object used in signalling that the caret has entered formatted text.
Expand All @@ -916,6 +924,22 @@ _Returns_

- `Object`: Action object.

<a name="insertAfterBlock" href="#insertAfterBlock">#</a> **insertAfterBlock**

Generator used to insert an empty block before a given blck

_Parameters_

- _clientId_ `string`:

<a name="insertBeforeBlock" href="#insertBeforeBlock">#</a> **insertBeforeBlock**

Generator used to insert an empty block after a given blck

_Parameters_

- _clientId_ `string`:

<a name="insertBlock" href="#insertBlock">#</a> **insertBlock**

Returns an action object used in signalling that a single block should be
Expand Down
6 changes: 6 additions & 0 deletions docs/manifest-devhub.json
Original file line number Diff line number Diff line change
Expand Up @@ -1355,6 +1355,12 @@
"markdown_source": "../packages/jest-puppeteer-axe/README.md",
"parent": "packages"
},
{
"title": "@wordpress/keyboard-shortcuts",
"slug": "packages-keyboard-shortcuts",
"markdown_source": "../packages/keyboard-shortcuts/README.md",
"parent": "packages"
},
{
"title": "@wordpress/keycodes",
"slug": "packages-keycodes",
Expand Down
12 changes: 12 additions & 0 deletions packages/keyboard-shortcuts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,18 @@ _This package assumes that your code will run in an **ES2015+** environment. If
## API

<!-- START TOKEN(Autogenerated API docs) -->

<a name="useShortcut" href="#useShortcut">#</a> **useShortcut**

Attach a keyboard shortcut handler.

_Parameters_

- _name_ `string`: Shortcut name.
- _callback_ `Function`: Shortcut callback.
- _options_ `Object`: Shortcut options.


<!-- END TOKEN(Autogenerated API docs) -->

<br/><br/><p align="center"><img src="https://s.w.org/style/images/codeispoetry.png?1" alt="Code is Poetry." /></p>

0 comments on commit 6708224

Please sign in to comment.