Update Docs generation

.gitignore

@@ -252,3 +252,4 @@ paket-files/
 *.sln.iml
 /test/ICSharpCode.SharpZipLib.TestBootstrapper/Properties/launchSettings.json
 _testRunner/
+docs/help/api/.manifest

appveyor.yml

@@ -18,10 +18,17 @@ nuget:
   disable_publish_on_pr: true
 before_build:
 - ps: nuget restore ICSharpCode.SharpZipLib.sln
+- ps: .\tools\appveyor-docfx-init.ps1
 build:
   project: ICSharpCode.SharpZipLib.sln
   publish_nuget: true
   publish_nuget_symbols: true
   verbosity: normal
+after_build:
+- ps: .\tools\appveyor-docfx-build.ps1
 test_script:
-- ps: tools/appveyor-test.ps1
+- ps: tools\appveyor-test.ps1
+artifacts:
+- path: docs\help\_site
+  type: zip
+  name: Documentation

docs/help/docfx.json

@@ -14,7 +14,10 @@
           ]
         }
       ],
-      "dest": "api"
+      "dest": "api",
+      "properties": {
+        "TargetFramework": "NETSTANDARD2"
+      }
     }
   ],
   "build": {
@@ -62,17 +65,22 @@
     ],
 	"globalMetadata": {
       "_appTitle": "SharpZipLib Help",
-	  "_appFooter": "Copyright © 2000-2017 SharpZipLib Contributors"
+      "_appFooter": "Copyright © 2000-2019 SharpZipLib Contributors",
+      "_gitContribute": {
+         "repo": "https://github.com/icsharpcode/SharpZipLib",
+         "branch": "master"
+      }
     },
     "dest": "_site",
     "globalMetadataFiles": [],
     "fileMetadataFiles": [],
     "template": [
-      "default"
+        "default",
+        "template"
     ],
     "postProcessors": [],
     "noLangKeyword": false,
     "keepFileLink": false,
     "cleanupCacheHistory": false
   }
-}
+}

docs/help/template/partials/navbar.tmpl.partial

@@ -0,0 +1,20 @@
+<nav id="autocollapse" class="navbar navbar-default ng-scope" role="navigation">
+  <div class="container">
+    <div class="navbar-header">
+      <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
+        <span class="sr-only">Toggle navigation</span>
+        <span class="icon-bar"></span>
+        <span class="icon-bar"></span>
+        <span class="icon-bar"></span>
+      </button>
+      {{>partials/logo}}
+    </div>
+    <div class="collapse navbar-collapse" id="navbar">
+      <form class="navbar-form navbar-right" role="search" id="search">
+        <div class="form-group">
+          <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
+        </div>
+      </form>
+    </div>
+  </div>
+</nav>

docs/help/template/styles/main.css

@@ -0,0 +1,17 @@
+button, a {
+    color: #516d86;
+    cursor: pointer;
+}
+
+.navbar-default .navbar-nav>.active>a, .navbar-default .navbar-nav>.active>a:focus, .navbar-default .navbar-nav>.active>a:hover {
+    color: #181c20;
+    background-color: #c4cdd4;
+}
+
+svg:hover path {
+    fill: currentColor;
+}
+
+.navbar-default .navbar-brand:focus, .navbar-default .navbar-brand:hover {
+    color: #3d4852;
+}

tools/appveyor-docfx-build.ps1

@@ -0,0 +1,24 @@
+if(-Not $env:APPVEYOR_PULL_REQUEST_TITLE -and $env:CONFIGURATION -eq "Release")
+{
+    pushd docs\help
+    # & docfx metadata
+    & docfx docfx.json
+    if ($lastexitcode -ne 0){
+      throw [System.Exception] "docfx build failed with exit code $lastexitcode."
+    }
+    popd
+<#  
+    ## Useful for automatically updating gh pages:
+
+    git config --global credential.helper store
+    Add-Content "$env:USERPROFILE\.git-credentials" "https://$($env:access_token):[email protected]`n"
+    git config --global user.email $env:op_build_user_email
+    git config --global user.name $env:op_build_user
+    git clone https://github.com/ICSharpCode/SharpZipLib.git -b gh-pages origin_site -q
+    Copy-Item origin_site/.git _site -recurse
+    CD _site
+    git add -A 2>&1
+    git commit -m "CI Updates" -q
+    git push origin gh-pages -q
+#>
+}

tools/appveyor-docfx-init.ps1

@@ -0,0 +1,5 @@
+if(-Not $env:APPVEYOR_PULL_REQUEST_TITLE -and $env:CONFIGURATION -eq "Release")
+{
+    git checkout $env:APPVEYOR_REPO_BRANCH -q
+    choco install docfx -y
+}