Update documentation infrastructure (#606)

viceroypenguin · Jan 19, 2024 · c11c552 · c11c552
1 parent 75a28f8
commit c11c552
Show file tree

Hide file tree

Showing 11 changed files with 803 additions and 879 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -13,10 +13,10 @@ concurrency:
 on: 
   workflow_dispatch:
   workflow_run:
-    workflows: ["Release"]
-    types: [completed]
-  release:
-    types: [released]
+    workflows:
+      - Release
+    types:
+      - completed
 
 jobs:
   docs:

diff --git a/Docs/SuperLinq.Docs/SuperLinq.Docs.csproj b/Docs/SuperLinq.Docs/SuperLinq.Docs.csproj
@@ -1,14 +1,14 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
-  <PropertyGroup>
-    <OutputType>Exe</OutputType>
-    <TargetFrameworks>net8.0</TargetFrameworks>
+	<PropertyGroup>
+		<OutputType>Exe</OutputType>
+		<TargetFrameworks>net8.0</TargetFrameworks>
 		<NoWarn>$(NoWarn);CA1852;NU1701</NoWarn>
 		<IsPackable>false</IsPackable>
-  </PropertyGroup>
+	</PropertyGroup>
 
 	<ItemGroup>
-		<PackageReference Include="DocFx.App" Version="2.70.0" />
+		<PackageReference Include="DocFx.App" Version="2.75.1" />
 	</ItemGroup>
 
 </Project>
diff --git a/Docs/SuperLinq.Docs/singulinkfx/singulinkfx/layout/_master.tmpl b/Docs/SuperLinq.Docs/singulinkfx/singulinkfx/layout/_master.tmpl
@@ -10,6 +10,8 @@
     {{>partials/head}}
 
     <body>
+        <!-- Header required for docfx anchor scroll to work -->
+        <header id="head"></header>
         <div class="top-navbar">
             <a class="burger-icon" onclick="toggleMenu()">
                 <svg name="Hamburger" 
@@ -39,11 +41,21 @@
                 {{>partials/searchResults}}
                 {{/_enableSearch}}
 
+
+
                 <div role="main" class="hide-when-search" >
                     {{^_disableBreadcrumb}}
                         {{>partials/breadcrumb}}
                     {{/_disableBreadcrumb}}
 
+                   {{^_disableContribution}}
+                         <div id="contribution">
+                             {{#docurl}}
+                               <a href="{{docurl}}" class="contribution-link">{{__global.improveThisDoc}}</a>
+                             {{/docurl}}
+                         </div>
+                    {{/_disableContribution}}
+
                     <article class="content wrap" id="_content" data-uid="{{uid}}">
                       {{!body}}
                     </article>

diff --git a/Docs/SuperLinq.Docs/singulinkfx/singulinkfx/partials/head.tmpl.partial b/Docs/SuperLinq.Docs/singulinkfx/singulinkfx/partials/head.tmpl.partial
@@ -13,7 +13,6 @@
   <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.7.0/styles/night-owl.min.css">
   <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap-icons@1.7.2/font/bootstrap-icons.css" integrity="sha384-EvBWSlnoFgZlXJvpzS+MAUEjvN7+gcCwH+qh7GRFOGgZO0PuwOFro7qPOJnLfe7l" crossorigin="anonymous">
   <link rel="stylesheet" href="{{_rel}}styles/config.css">
-  <link rel="stylesheet" href="{{_rel}}styles/discord.css">
   <link rel="stylesheet" href="{{_rel}}styles/singulink.css">
   <link rel="stylesheet" href="{{_rel}}styles/main.css">
   <meta property="docfx:navrel" content="{{_navRel}}">

diff --git a/Docs/SuperLinq.Docs/singulinkfx/singulinkfx/partials/scripts.tmpl.partial b/Docs/SuperLinq.Docs/singulinkfx/singulinkfx/partials/scripts.tmpl.partial
@@ -4,10 +4,10 @@
 <script src="https://cdn.jsdelivr.net/npm/popper.js@1.16.1/dist/umd/popper.min.js" integrity="sha384-9/reFTGAW83EW2RDu2S0VKaIzap3H66lZH81PoYlFhbGU+6BZp6G7niu735Sk7lN" crossorigin="anonymous"></script>
 <script src="https://cdn.jsdelivr.net/npm/bootstrap@4.6.2/dist/js/bootstrap.min.js" integrity="sha384-+sLIOodYLS7CIrQpBjl+C7nPvqq+FbNUBDunl/OZv93DB7Ln/533i8e/mZXLi/P+" crossorigin="anonymous"></script>
 <script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/11.7.0/highlight.min.js"></script>
-<script type="text/javascript" src="{{_rel}}styles/jquery.twbsPagination.js"></script>
+<script type="text/javascript" src="{{_rel}}styles/jquery.twbsPagination.min.js"></script>
 <script src="https://cdn.jsdelivr.net/npm/mark.js@8.11.1/dist/jquery.mark.min.js"></script>
 <script type="text/javascript" src="{{_rel}}styles/url.min.js"></script>
 <script src="https://cdn.jsdelivr.net/npm/anchor-js@5.0.0/anchor.min.js"></script>
 <script type="text/javascript" src="{{_rel}}styles/docfx.js"></script>
-<script type="text/javascript" src="{{_rel}}styles/singulink.js"></script>
-<script type="text/javascript" src="{{_rel}}styles/main.js"></script>
+<script type="text/javascript" src="{{_rel}}styles/main.js"></script>
+<script type="text/javascript" src="{{_rel}}styles/singulink.js"></script>
diff --git a/Docs/SuperLinq.Docs/singulinkfx/singulinkfx/styles/config.css b/Docs/SuperLinq.Docs/singulinkfx/singulinkfx/styles/config.css
@@ -84,6 +84,16 @@
 
     --breadcrumb-bg-color: #2f3136;
 
+    /* Tabs */
+
+    --nav-tabs-border-width: 1px;
+    --nav-tabs-border-color: #495057;
+    --nav-tabs-border-radius: .375rem;
+    --nav-tabs-link-hover-border-color: #303336 #303336 transparent;
+    --nav-tabs-link-active-color: white;
+    --nav-tabs-link-active-bg: var(--main-bg-color);
+    --nav-tabs-link-active-border-color: var(--nav-tabs-border-color) var(--nav-tabs-border-color) var(--main-bg-color);
+
     /* Inline Code */
 
     --ref-bg-color: black;