From cdbf52f68d1e5357741eb346c2d534d562c6dd86 Mon Sep 17 00:00:00 2001 From: Yury Semikhatsky Date: Tue, 6 Apr 2021 22:23:55 -0700 Subject: [PATCH] docs: add basic intro page for C# (#6110) --- docs/src/intro-csharp.md | 59 ++++++++++++++++++++++++++++++++++++++++ docs/src/intro-java.md | 2 +- docs/src/intro-js.md | 2 +- docs/src/intro-python.md | 2 +- 4 files changed, 62 insertions(+), 3 deletions(-) create mode 100644 docs/src/intro-csharp.md diff --git a/docs/src/intro-csharp.md b/docs/src/intro-csharp.md new file mode 100644 index 0000000000..dc536a2c7e --- /dev/null +++ b/docs/src/intro-csharp.md @@ -0,0 +1,59 @@ +--- +id: intro +title: "Getting Started" +--- + + +- [Release notes](./release-notes.md) + +## Installation + +Install PlaywrightSharp package from NuGet in Visual Studio or from the CLI in your project root directory: + +```sh +dotnet add package PlaywrightSharp +``` + +## Usage + +```csharp +using var playwright = await Playwright.CreateAsync(); +await using var browser = await playwright.Chromium.LaunchAsync(); +var page = await browser.NewPageAsync(); +await page.GoToAsync("http://www.bing.com"); +await page.ScreenshotAsync(path: outputFile); +``` + +## First script + +In our first script, we will navigate to `whatsmyuseragent.org` and take a screenshot in WebKit. + +```csharp +// FIXME: +``` + +By default, Playwright runs the browsers in headless mode. To see the browser UI, pass the `headless=False` flag while launching the browser. You can also use [`option: slowMo`] to slow down execution. Learn more in the debugging tools [section](./debug.md). + +```csharp +// FIXME: +``` + +## Record scripts + +Command Line Interface [CLI](./cli.md) can be used to record user interactions and generate C# code. + +```sh +# FIXME: +``` + +## System requirements + +The browser binaries for Chromium, Firefox and WebKit work across the 3 platforms (Windows, macOS, Linux): + +* **Windows**: Works with Windows and Windows Subsystem for Linux (WSL). +* **macOS**: Requires 10.14 or above. +* **Linux**: Depending on your Linux distribution, you might need to install additional + dependencies to run the browsers. + * Firefox requires Ubuntu 18.04+ + * For Ubuntu 20.04, the additional dependencies are defined in [our Docker image](https://github.com/microsoft/playwright/blob/master/utils/docker/Dockerfile.focal), + which is based on Ubuntu. diff --git a/docs/src/intro-java.md b/docs/src/intro-java.md index 06bfa947ce..20a3b6f62e 100644 --- a/docs/src/intro-java.md +++ b/docs/src/intro-java.md @@ -133,5 +133,5 @@ Firefox and WebKit work across the 3 platforms (Windows, macOS, Linux): * **Linux**: Depending on your Linux distribution, you might need to install additional dependencies to run the browsers. * Firefox requires Ubuntu 18.04+ - * For Ubuntu 18.04, the additional dependencies are defined in [our Docker image](https://github.com/microsoft/playwright/blob/master/utils/docker/Dockerfile.bionic), + * For Ubuntu 20.04, the additional dependencies are defined in [our Docker image](https://github.com/microsoft/playwright/blob/master/utils/docker/Dockerfile.focal), which is based on Ubuntu. diff --git a/docs/src/intro-js.md b/docs/src/intro-js.md index 4736a1dcbf..33d8d0cb49 100644 --- a/docs/src/intro-js.md +++ b/docs/src/intro-js.md @@ -105,5 +105,5 @@ Firefox and WebKit work across the 3 platforms (Windows, macOS, Linux): * **Linux**: Depending on your Linux distribution, you might need to install additional dependencies to run the browsers. * Firefox requires Ubuntu 18.04+ - * For Ubuntu 18.04, the additional dependencies are defined in [our Docker image](https://github.com/microsoft/playwright/blob/master/utils/docker/Dockerfile.bionic), + * For Ubuntu 20.04, the additional dependencies are defined in [our Docker image](https://github.com/microsoft/playwright/blob/master/utils/docker/Dockerfile.focal), which is based on Ubuntu. diff --git a/docs/src/intro-python.md b/docs/src/intro-python.md index 59ee552d6c..fa55706bfe 100644 --- a/docs/src/intro-python.md +++ b/docs/src/intro-python.md @@ -88,5 +88,5 @@ Firefox and WebKit work across the 3 platforms (Windows, macOS, Linux): * **Linux**: Depending on your Linux distribution, you might need to install additional dependencies to run the browsers. * Firefox requires Ubuntu 18.04+ - * For Ubuntu 18.04, the additional dependencies are defined in [our Docker image](https://github.com/microsoft/playwright/blob/master/utils/docker/Dockerfile.bionic), + * For Ubuntu 20.04, the additional dependencies are defined in [our Docker image](https://github.com/microsoft/playwright/blob/master/utils/docker/Dockerfile.focal), which is based on Ubuntu.