DocFx implementation (hardkoded#318)

TheBlubb14 · Jun 11, 2018 · ff583c3 · ff583c3
1 parent bece88a
commit ff583c3
Show file tree

Hide file tree

Showing 17 changed files with 845 additions and 8 deletions.
diff --git a/.gitignore b/.gitignore
@@ -293,4 +293,5 @@ Thumbs.db
 /lib/PuppeteerSharp.Tests/Screenshots/test.png
 
 demos/PuppeteerSharpPdfDemo/google.pdf
-demos/PuppeteerSharpPdfDemo/.local-chromium/
+demos/PuppeteerSharpPdfDemo/.local-chromium/
+docs/
diff --git a/README.md b/README.md
@@ -10,6 +10,14 @@
 
 Puppeteer Sharp is a .NET port of the official [Node.JS Puppeteer API](https://github.com/GoogleChrome/puppeteer). 
 
+# Useful links
+
+* [API Documentation](http://www.puppeteersharp.com/api/index.html)
+* Slack channel [#puppeteer-sharp](https://join.slack.com/t/puppeteer/shared_invite/enQtMzU4MjIyMDA5NTM4LTM1OTdkNDhlM2Y4ZGUzZDdjYjM5ZWZlZGFiZjc4MTkyYTVlYzIzYjU5NDIyNzgyMmFiNDFjN2UzNWU0N2ZhZDc)
+* [StackOverflow](https://stackoverflow.com/search?q=puppeteer-sharp)
+* [Issues](https://github.com/kblok/puppeteer-sharp/issues?utf8=%E2%9C%93&q=is%3Aissue)
+
+
 # Usage
 
 ## Take screenshots
@@ -127,9 +135,3 @@ using (var browser = await PuppeteerSharp.Puppeteer.ConnectAsync(options))
 * Tests on Google's Puppeteer: 405.
 * Tests on Puppeteer Sharp: 322.
 * Passing tests: 319.
-
-# Useful links
-
-* Slack channel [#puppeteer-sharp](https://join.slack.com/t/puppeteer/shared_invite/enQtMzU4MjIyMDA5NTM4LTM1OTdkNDhlM2Y4ZGUzZDdjYjM5ZWZlZGFiZjc4MTkyYTVlYzIzYjU5NDIyNzgyMmFiNDFjN2UzNWU0N2ZhZDc)
-* [StackOverflow](https://stackoverflow.com/search?q=puppeteer-sharp)
-* [Issues](https://github.com/kblok/puppeteer-sharp/issues?utf8=%E2%9C%93&q=is%3Aissue)
diff --git a/appveyor.yml b/appveyor.yml
@@ -5,9 +5,16 @@ branches:
 image: Visual Studio 2017
 configuration: Release
 environment:
+  git_access_token:
+    secure: FxcQ9C8a/NgcQB5dFdZts6ZWEDT4zMhA4qPQAYwWc7huMmhmTIl1sbFEIaAWQMTL
   matrix:
     - framework: net471
     - framework: netcoreapp2.0
+install:
+- ps: >-
+    if($env:APPVEYOR_REPO_TAG -eq 'True' -And $env:framework -eq 'netcoreapp2.0') {
+        choco install docfx
+    }
 before_build:
 - ps: >-
     dotnet restore .\lib\PuppeteerSharp.sln
@@ -26,6 +33,7 @@ test_script:
     cd .\lib\PuppeteerSharp.Tests
 
     dotnet test -f %framework% -s test.runsettings
-
+on_success:
+- ps: c:\projects\puppeteer-sharp\appveyor\GenerateDocs.ps1
 cache:
   - $HOME/.nuget/packages
diff --git a/appveyor/GenerateDocs.ps1 b/appveyor/GenerateDocs.ps1
@@ -0,0 +1,16 @@
+if($env:APPVEYOR_REPO_TAG -eq 'True' -And $env:framework -eq 'netcoreapp2.0') {
+    git config --global credential.helper store
+    Add-Content "$env:USERPROFILE\.git-credentials" "https://$($env:git_access_token):x-oauth-basic@github.com`n"
+
+    git config --global user.email "dariokondratiuk@gmail.com"
+    git config --global user.name "Darío Kondratiuk"
+    git remote add pages https://github.com/kblok/puppeteer-sharp.git
+    git fetch pages
+    git checkout master
+    git subtree add --prefix docs pages/gh-pages
+    docfx metadata docfx_project/docfx.json
+    docfx build docfx_project/docfx.json -o docs
+    git add docs/* -f
+    git commit -m "Docs version $($env:APPVEYOR_REPO_TAG_NAME)"
+    git subtree push --prefix docs pages gh-pages
+}
diff --git a/docfx_project/.gitignore b/docfx_project/.gitignore
@@ -0,0 +1,9 @@
+###############
+#    folder   #
+###############
+/**/DROP/
+/**/TEMP/
+/**/packages/
+/**/bin/
+/**/obj/
+_site
diff --git a/docfx_project/api/.gitignore b/docfx_project/api/.gitignore
@@ -0,0 +1,5 @@
+###############
+#  temp file  #
+###############
+*.yml
+.manifest
diff --git a/docfx_project/api/index.md b/docfx_project/api/index.md
@@ -0,0 +1,108 @@
+# Puppeteer Sharp
+
+Puppeteer Sharp is a .NET port of the official [Node.JS Puppeteer API](https://github.com/GoogleChrome/puppeteer). 
+
+# Usage
+
+## Take screenshots
+
+```cs
+await Downloader.CreateDefault().DownloadRevisionAsync(chromiumRevision);
+var browser = await Puppeteer.LaunchAsync(new LaunchOptions
+{
+    Headless = true
+}, chromiumRevision);
+var page = await browser.NewPageAsync();
+await page.GoToAsync("http://www.google.com");
+await page.ScreenshotAsync(outputFile);
+```
+
+You can also change the view port before generating the screenshot
+
+
+```cs
+await page.SetViewport(new ViewPortOptions
+{
+    Width = 500,
+    Height = 500
+});
+```
+
+
+## Generate PDF files
+
+```cs
+await Downloader.CreateDefault().DownloadRevisionAsync(chromiumRevision);
+var browser = await Puppeteer.LaunchAsync(new LaunchOptions
+{
+    Headless = true
+}, chromiumRevision);
+var page = await browser.NewPageAsync();
+await page.GoToAsync("http://www.google.com");
+await page.PdfAsync(outputFile);
+```
+
+## Inject HTML
+
+```cs
+using(var page = await Browser.NewPageAsync())
+{
+    await page.SetContentAsync("<div>My Receipt</div>");
+    var result = await page.GetContentAsync();
+    await page.PdfAsync(outputFile);
+    SaveHtmlToDB(result);
+}
+```
+
+## Evaluate Javascript
+
+```cs
+using (var page = await Browser.NewPageAsync())
+{
+    var seven = await page.EvaluateFunctionAsync<int>(“4 + 3”);
+    var someObject = await page.EvaluateFunctionAsync<dynamic>("(value) => ({a: value})", 5);
+    Console.WriteLine(someObject.a);
+}
+```
+
+## Wait For Selector
+
+```cs
+using (var page = await Browser.NewPageAsync())
+{
+    await page.GoToAsync("http://www.spapage.com");
+    await page.WaitForSelectorAsync("div.main-content")
+    await page.PdfAsync(outputFile));
+}
+```
+
+## Wait For Function
+```cs
+using (var page = await Browser.NewPageAsync())
+{
+    await page.GoToAsync("http://www.spapage.com");
+    var watchDog = page.WaitForFunctionAsync("window.innerWidth < 100");
+    await Page.SetViewport(new ViewPortOptions { Width = 50, Height = 50 });
+    await watchDog;
+}
+```
+
+## Connect to a remote browser
+
+```cs
+var options = new ConnectOptions()
+{
+    BrowserWSEndpoint = $"wss://www.externalbrowser.io?token={apikey}"
+};
+
+var url = "https://www.google.com/";
+
+using (var browser = await PuppeteerSharp.Puppeteer.ConnectAsync(options))
+{
+    using (var page = await browser.NewPageAsync())
+    {
+        await page.GoToAsync(url);
+        await page.PdfAsync("wot.pdf");
+    }
+}
+```
diff --git a/docfx_project/docfx.json b/docfx_project/docfx.json
@@ -0,0 +1,66 @@
+{
+  "metadata": [
+    {
+      "src": [
+        {
+          "cwd": "../",
+          "files": [
+            "lib/PuppeteerSharp/**.csproj"
+          ]
+        }
+      ],
+      "dest": "api",
+      "disableGitFeatures": false,
+      "properties": {
+        "TargetFramework": "net46"
+      }
+    }
+  ],
+  "build": {
+    "content": [
+      {
+        "files": [
+          "api/**.yml",
+          "api/index.md"
+        ]
+      },
+      {
+        "files": [
+          "toc.yml",
+          "*.md"
+        ]
+      }
+    ],
+    "resource": [
+      {
+        "files": [
+          "images/**"
+        ]
+      }
+    ],
+    "overwrite": [
+      {
+        "files": [
+          "apidoc/**.md"
+        ],
+        "exclude": [
+          "obj/**",
+          "_site/**"
+        ]
+      }
+    ],
+    "dest": ".",
+    "globalMetadataFiles": [],
+    "fileMetadataFiles": [],
+    "template": [
+      "default",
+      "./template"
+    ],
+    "postProcessors": [],
+    "markdownEngineName": "markdig",
+    "noLangKeyword": false,
+    "keepFileLink": false,
+    "cleanupCacheHistory": false,
+    "disableGitFeatures": false
+  }
+}