Update docfx (#2387)

* Update docfx

* restore default

* Customize docfx

Author: kblok

.github/workflows/publish-docs.yml

@@ -26,7 +26,7 @@ jobs:
           dotnet-version: ${{ env.DOTNET_VERSION }}
       - name: Build
         run: |
-          dotnet tool install --global docfx --version 2.60.2
+          dotnet tool install --global docfx --version 2.74.1
 
           docfx metadata docfx_project\docfx.json
           docfx build docfx_project\docfx.json -o docs

docfx_project/docfx.json

@@ -3,17 +3,18 @@
     {
       "src": [
         {
-          "cwd": "../",
           "files": [
-            "lib/PuppeteerSharp/**.csproj"
-          ]
+            "**.csproj"
+        ],
+        "src": "../lib/PuppeteerSharp"
         }
       ],
       "dest": "api",
       "disableGitFeatures": false,
       "properties": {
-        "TargetFramework": "net46"
-      }
+        "TargetFramework": "net8"
+    },
+    "allowCompilationErrors": true
     }
   ],
   "build": {
@@ -59,10 +60,15 @@
     "globalMetadataFiles": [],
     "fileMetadataFiles": [],
     "template": [
-      "default",
-      "./template"
+        "default",
+        "modern",
+        "./templates/custom"
     ],
     "postProcessors": [],
+    "globalMetadata": {
+        "_appFooter": "<span>Made with love by <a href=\"https://www.hardkoded.com\" rel=\"noreferrer\">Dario Kondratiuk</a></span>",
+        "_googleAnalyticsTagId": "UA-586295-9"
+    },
     "markdownEngineName": "markdig",
     "noLangKeyword": false,
     "keepFileLink": false,
@@ -73,4 +79,4 @@
         "priority": 1
     }
   }
-}
+}

docfx_project/readme.md

@@ -0,0 +1,11 @@
+# DocFX configuration
+
+## Customizations
+
+These are the changes made in the custom template.
+
+* `conceptual.html.primary.js`: Add the `docurl` pointing to the GitHub issues page.
+* 'logo.svg` is the puppeteer-sharp logo.
+* `ManagedReference.common.js` is the same as the one in `common` but we are setting the `docurl` to point to the GitHub issues page.
+* `token.json`. We change the `improveThisDoc` text.
+* `partials/class.header.tmpl.partial`: The `inherited members` section was removed.

docfx_project/template/partials/footer.tmpl.partial

@@ -0,0 +1,7 @@
+root = false
+
+# Settings for Docfx template files
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2

docfx_project/template/partials/scripts.tmpl.partial

@@ -0,0 +1,16 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+module.exports = {
+  env: {
+    browser: true
+  },
+  ignorePatterns: ['**/*.js'],
+  extends: ['standard', 'eslint:recommended', 'plugin:@typescript-eslint/recommended'],
+  parser: '@typescript-eslint/parser',
+  plugins: ['@typescript-eslint'],
+  root: true,
+  rules: {
+    'space-before-function-paren': ['warn', 'never'],
+  }
+};

docfx_project/templates/.editorconfig

@@ -0,0 +1,11 @@
+*.min.js
+*.min.css
+*.map
+*.woff
+*.woff2
+
+glyphicons-*.*
+
+dist
+fonts
+node_modules

docfx_project/templates/.eslintrc.js

@@ -0,0 +1,16 @@
+{
+  "extends": "stylelint-config-standard-scss",
+  "ignoreFiles": [
+    "**/*.ts",
+    "**/*.js"
+  ],
+  "rules": {
+    "selector-class-pattern": null,
+    "media-feature-range-notation": null,
+    "font-family-no-missing-generic-family-keyword": [ true, {
+      "ignoreFontFamilies": [
+        "bootstrap-icons"
+      ]
+    }]
+  }
+}

docfx_project/templates/.gitignore

@@ -0,0 +1 @@
+This folder contains the source code for website themes used by docfx.exe.