From ba00cbb99e85a570ba73cbd5c06515a57fb6f9cd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andr=C3=A9s?= Date: Fri, 1 Mar 2019 19:42:48 +0100 Subject: [PATCH] Autogenerated docs and setup for dom-ready --- packages/dom-ready/README.md | 23 ++++++++++++++++++++++- packages/dom-ready/package.json | 6 ++++++ 2 files changed, 28 insertions(+), 1 deletion(-) diff --git a/packages/dom-ready/README.md b/packages/dom-ready/README.md index c262e04a93a62..9f4675a8afdac 100644 --- a/packages/dom-ready/README.md +++ b/packages/dom-ready/README.md @@ -24,6 +24,27 @@ domReady( function() { ## Browser support -See https://make.wordpress.org/design/handbook/design-guide/browser-support/ +See + +## API + + + +### default + +[src/index.js#L20-L20](src/index.js#L20-L20) + +Specify a function to execute when the DOM is fully loaded. + +**Parameters** + +- **callback** `Function`: A function to execute after the DOM is ready. + +**Returns** + +`void` + + +

Code is Poetry.

diff --git a/packages/dom-ready/package.json b/packages/dom-ready/package.json index 8d88781a9e4fb..9a13ac3903c1b 100644 --- a/packages/dom-ready/package.json +++ b/packages/dom-ready/package.json @@ -22,7 +22,13 @@ "dependencies": { "@babel/runtime": "^7.3.1" }, + "devDependencies": { + "@wordpress/docgen": "file:../docgen" + }, "publishConfig": { "access": "public" + }, + "scripts": { + "docs:generate": "docgen ./src/index.js --output ./README.md --to-token" } }