docs: install memberpage plugin

azyobuzin · Mar 24, 2021 · 1e81584 · 1e81584
1 parent 0ebfdcc
commit 1e81584
Show file tree

Hide file tree

Showing 9 changed files with 35 additions and 12 deletions.
diff --git a/.github/workflows/ghpages.yml b/.github/workflows/ghpages.yml
@@ -11,11 +11,14 @@ jobs:
       - name: dotnet restore
         run: dotnet restore
 
-      - name: Install docfx
-        run: choco install docfx -y
+      - name: paket install
+        run: |
+          dotnet tool restore
+          dotnet paket install
+        working-directory: docs
 
       - name: Build
-        run: docfx
+        run: ./packages/docfx.console/tools/docfx
         working-directory: docs
 
       - name: Deploy

diff --git a/.gitignore b/.gitignore
@@ -142,7 +142,9 @@ _TeamCity*
 !.axoCover/settings.json
 
 # Coverlet is a free, cross platform Code Coverage Tool
-coverage*[.json, .xml, .info]
+coverage*.json
+coverage*.xml
+coverage*.info
 
 # Visual Studio code coverage results
 *.coverage
@@ -358,6 +360,3 @@ MigrationBackup/
 
 # Fody - auto-generated XML schema
 FodyWeavers.xsd
-
-# docfx
-_site/
diff --git a/docs/.config/dotnet-tools.json b/docs/.config/dotnet-tools.json
@@ -0,0 +1,12 @@
+{
+  "version": 1,
+  "isRoot": true,
+  "tools": {
+    "paket": {
+      "version": "5.257.0",
+      "commands": [
+        "paket"
+      ]
+    }
+  }
+}
diff --git a/docs/.gitignore b/docs/.gitignore
@@ -0,0 +1,3 @@
+/_site/
+/paket.lock
+/packages/
diff --git a/docs/docfx.json b/docs/docfx.json
@@ -24,7 +24,8 @@
     ],
     "dest": "_site",
     "template": [
-      "default"
+      "default",
+      "./packages/memberpage/content"
     ],
     "xrefService": [
       "https://xref.docs.microsoft.com/query?uid={uid}"

diff --git a/docs/paket.dependencies b/docs/paket.dependencies
@@ -0,0 +1,5 @@
+storage: packages
+source https://api.nuget.org/v3/index.json
+
+nuget docfx.console ~> 2.56
+nuget memberpage ~> 2.56
diff --git a/src/BiDaFlow.AsyncEnumerable/Fluent/DataflowAsyncEnumerable.cs b/src/BiDaFlow.AsyncEnumerable/Fluent/DataflowAsyncEnumerable.cs
@@ -79,7 +79,7 @@ public static IAsyncEnumerable<TOutput> AsAsyncEnumerable<TOutput>(this ISourceB
         /// </para>
         /// </remarks>
         /// <example>
-        /// <code><![CDATA[
+        /// <code language="csharp"><![CDATA[
         /// await AsyncEnumerable.Range(1, 100)
         ///     // Process elements in parallel with IPropagatorBlock
         ///     .RunThroughDataflowBlock(cancellationToken =>

diff --git a/src/BiDaFlow/Blocks/DropBlock.cs b/src/BiDaFlow/Blocks/DropBlock.cs
@@ -9,7 +9,7 @@ namespace BiDaFlow.Blocks
     /// Provides a dataflow block that drops input items.
     /// </summary>
     /// <example>
-    /// <code><![CDATA[
+    /// <code language="csharp"><![CDATA[
     /// var sourceBlock = new BufferBlock<int>();
     /// for (int i = 1; i <= 5; i++)
     ///     sourceBlock.Post(i);

diff --git a/src/BiDaFlow/Fluent/FluentDataflow.cs b/src/BiDaFlow/Fluent/FluentDataflow.cs
@@ -349,7 +349,7 @@ public static IPropagatorBlock<TInput, TOutput> Merge<TInput, TOutput>(this IPro
         /// </remarks>
         /// <example>
         /// This sample shows how to merge some source blocks.
-        /// <code><![CDATA[
+        /// <code language="csharp"><![CDATA[
         /// IReadOnlyList<ISourceBlock<T>> sources;
         /// ITargetBlock<T> target;
         /// 
@@ -431,7 +431,7 @@ public static IDisposable LinkWithProbe<T>(this ISourceBlock<T> source, ITargetB
 
         /// <exception cref="ArgumentNullException"><paramref name="source"/>, <paramref name="target"/> or <paramref name="probe"/> is <see langword="null"/>.</exception>
         /// <example>
-        /// <code><![CDATA[
+        /// <code language="csharp"><![CDATA[
         /// IDisposable unlinker = source.LinkWithProbe(target, new ConsoleProbe<T>("ExampleLink"));
         /// 
         /// class ConsoleProbe<T> : ILinkProbe<T>