docs: generate api.md off documentation model (#4832)

microsoft · Dec 28, 2020 · a446792 · a446792
1 parent fee7dd7
commit a446792
Show file tree

Hide file tree

Showing 11 changed files with 1,659 additions and 1,139 deletions.
diff --git a/docs-src/api-body.md b/docs-src/api-body.md
diff --git a/docs-src/api-footer.md b/docs-src/api-footer.md
@@ -155,63 +155,3 @@ const { chromium } = require('playwright');
 > **NOTE** It is not yet possible to test extension popups or content scripts.
 
 
-[AXNode]: #accessibilitysnapshotoptions "AXNode"
-[Accessibility]: #class-accessibility "Accessibility"
-[Array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array "Array"
-[Body]: #class-body  "Body"
-[BrowserServer]: #class-browserserver  "BrowserServer"
-[BrowserContext]: #class-browsercontext  "BrowserContext"
-[BrowserType]: #class-browsertype "BrowserType"
-[Browser]: #class-browser  "Browser"
-[Buffer]: https://nodejs.org/api/buffer.html#buffer_class_buffer "Buffer"
-[ChildProcess]: https://nodejs.org/api/child_process.html "ChildProcess"
-[ChromiumBrowser]: #class-chromiumbrowser "ChromiumBrowser"
-[ChromiumBrowserContext]: #class-chromiumbrowsercontext "ChromiumBrowserContext"
-[ChromiumCoverage]: #class-chromiumcoverage "ChromiumCoverage"
-[CDPSession]: #class-cdpsession  "CDPSession"
-[ConsoleMessage]: #class-consolemessage "ConsoleMessage"
-[Dialog]: #class-dialog "Dialog"
-[Download]: #class-download "Download"
-[ElementHandle]: #class-elementhandle "ElementHandle"
-[Element]: https://developer.mozilla.org/en-US/docs/Web/API/element "Element"
-[Error]: https://nodejs.org/api/errors.html#errors_class_error "Error"
-[EvaluationArgument]: #evaluationargument "Evaluation Argument"
-[File]: #class-file "https://developer.mozilla.org/en-US/docs/Web/API/File"
-[FileChooser]: #class-filechooser "FileChooser"
-[FirefoxBrowser]: #class-firefoxbrowser "FirefoxBrowser"
-[Frame]: #class-frame "Frame"
-[JSHandle]: #class-jshandle "JSHandle"
-[Keyboard]: #class-keyboard "Keyboard"
-[Logger]: #class-logger "Logger"
-[Map]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map "Map"
-[Mouse]: #class-mouse "Mouse"
-[Object]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object "Object"
-[Page]: #class-page "Page"
-[Playwright]: #class-playwright "Playwright"
-[Promise]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise "Promise"
-[RegExp]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp
-[Request]: #class-request  "Request"
-[Response]: #class-response  "Response"
-[Route]: #class-route  "Route"
-[Selectors]: #class-selectors  "Selectors"
-[Serializable]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#Description "Serializable"
-[TimeoutError]: #class-timeouterror "TimeoutError"
-[Touchscreen]: #class-touchscreen "Touchscreen"
-[UIEvent.detail]: https://developer.mozilla.org/en-US/docs/Web/API/UIEvent/detail "UIEvent.detail"
-[URL]: https://nodejs.org/api/url.html
-[USKeyboardLayout]: ../src/usKeyboardLayout.ts "USKeyboardLayout"
-[UnixTime]: https://en.wikipedia.org/wiki/Unix_time "Unix Time"
-[Video]: #class-video "Video"
-[WebKitBrowser]: #class-webkitbrowser "WebKitBrowser"
-[WebSocket]: #class-websocket "WebSocket"
-[Worker]: #class-worker "Worker"
-[boolean]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type "Boolean"
-[function]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function "Function"
-[iterator]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols "Iterator"
-[null]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/null
-[number]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type "Number"
-[origin]: https://developer.mozilla.org/en-US/docs/Glossary/Origin "Origin"
-[selector]: https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Selectors "selector"
-[Readable]: https://nodejs.org/api/stream.html#stream_class_stream_readable "Readable"
-[string]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type "String"
-[xpath]: https://developer.mozilla.org/en-US/docs/Web/XPath "xpath"
diff --git a/docs-src/api-links.md b/docs-src/api-links.md
@@ -0,0 +1,25 @@
+[Array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array "Array"
+[Buffer]: https://nodejs.org/api/buffer.html#buffer_class_buffer "Buffer"
+[ChildProcess]: https://nodejs.org/api/child_process.html "ChildProcess"
+[Element]: https://developer.mozilla.org/en-US/docs/Web/API/element "Element"
+[Error]: https://nodejs.org/api/errors.html#errors_class_error "Error"
+[EvaluationArgument]: #evaluationargument "Evaluation Argument"
+[Map]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map "Map"
+[Object]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object "Object"
+[Promise]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise "Promise"
+[RegExp]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp "RegExp"
+[Serializable]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#Description "Serializable"
+[UIEvent.detail]: https://developer.mozilla.org/en-US/docs/Web/API/UIEvent/detail "UIEvent.detail"
+[URL]: https://nodejs.org/api/url.html "URL"
+[USKeyboardLayout]: ../src/usKeyboardLayout.ts "USKeyboardLayout"
+[UnixTime]: https://en.wikipedia.org/wiki/Unix_time "Unix Time"
+[boolean]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type "Boolean"
+[function]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function "Function"
+[iterator]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols "Iterator"
+[null]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/null "null"
+[number]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type "Number"
+[origin]: https://developer.mozilla.org/en-US/docs/Glossary/Origin "Origin"
+[selector]: https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Selectors "selector"
+[Readable]: https://nodejs.org/api/stream.html#stream_class_stream_readable "Readable"
+[string]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type "string"
+[xpath]: https://developer.mozilla.org/en-US/docs/Web/XPath "xpath"
diff --git a/docs-src/api-params.md b/docs-src/api-params.md
@@ -170,7 +170,7 @@ Whether or not to enable JavaScript in the context. Defaults to `true`.
 ## context-option-timezoneid
 - `timezoneId` <[string]>
 
-Changes the timezone of the context. See [ICU’s `metaZones.txt`](https://cs.chromium.org/chromium/src/third_party/icu/source/data/misc/metaZones.txt?rcl=faee8bc70570192d82d2978a71e2a615788597d1)
+Changes the timezone of the context. See [ICU's metaZones.txt](https://cs.chromium.org/chromium/src/third_party/icu/source/data/misc/metaZones.txt?rcl=faee8bc70570192d82d2978a71e2a615788597d1)
 for a list of supported timezone IDs.
 
 ## context-option-geolocation