Merge pull request #10 from mpanhuijsen/main

Updated to logo and top navigation, to be merged into RWS main.
RWS · Feb 13, 2023 · 8564303 · 8564303
2 parents f37132f + 749846c
commit 8564303
Show file tree

Hide file tree

Showing 42 changed files with 1,143 additions and 203 deletions.
diff --git a/.vs/ProjectSettings.json b/.vs/ProjectSettings.json
@@ -0,0 +1,3 @@
+{
+  "CurrentProjectSetting": null
+}
diff --git a/.vs/VSWorkspaceState.json b/.vs/VSWorkspaceState.json
@@ -0,0 +1,8 @@
+{
+  "ExpandedNodes": [
+    "",
+    "\\RWSDocsTemplate"
+  ],
+  "SelectedNode": "\\RWSDocsTemplate",
+  "PreviewInSolutionExplorer": false
+}
diff --git a/.vs/slnx.sqlite b/.vs/slnx.sqlite
diff --git a/.vs/tridion-docs-api-docs-top-banner-update/config/applicationhost.config b/.vs/tridion-docs-api-docs-top-banner-update/config/applicationhost.config
diff --git a/.vs/tridion-docs-api-docs-top-banner-update/v16/.suo b/.vs/tridion-docs-api-docs-top-banner-update/v16/.suo
diff --git a/RWSDocsTemplate/Plugins/HtmlAgilityPack.dll b/RWSDocsTemplate/Plugins/HtmlAgilityPack.dll
diff --git a/RWSDocsTemplate/Plugins/HtmlAgilityPack.pdb b/RWSDocsTemplate/Plugins/HtmlAgilityPack.pdb
diff --git a/RWSDocsTemplate/Plugins/Microsoft.DocAsCode.Common.dll b/RWSDocsTemplate/Plugins/Microsoft.DocAsCode.Common.dll
diff --git a/RWSDocsTemplate/Plugins/Microsoft.DocAsCode.Dfm.dll b/RWSDocsTemplate/Plugins/Microsoft.DocAsCode.Dfm.dll
diff --git a/RWSDocsTemplate/Plugins/Microsoft.DocAsCode.MarkdownLite.dll b/RWSDocsTemplate/Plugins/Microsoft.DocAsCode.MarkdownLite.dll
diff --git a/RWSDocsTemplate/Plugins/Microsoft.DocAsCode.Plugins.dll b/RWSDocsTemplate/Plugins/Microsoft.DocAsCode.Plugins.dll
diff --git a/RWSDocsTemplate/Plugins/Microsoft.DocAsCode.YamlSerialization.dll b/RWSDocsTemplate/Plugins/Microsoft.DocAsCode.YamlSerialization.dll
diff --git a/RWSDocsTemplate/Plugins/Newtonsoft.Json.dll b/RWSDocsTemplate/Plugins/Newtonsoft.Json.dll
diff --git a/RWSDocsTemplate/Plugins/System.Buffers.dll b/RWSDocsTemplate/Plugins/System.Buffers.dll
diff --git a/RWSDocsTemplate/Plugins/System.Collections.Immutable.dll b/RWSDocsTemplate/Plugins/System.Collections.Immutable.dll
diff --git a/RWSDocsTemplate/Plugins/System.Composition.AttributedModel.dll b/RWSDocsTemplate/Plugins/System.Composition.AttributedModel.dll
diff --git a/RWSDocsTemplate/Plugins/System.Composition.Convention.dll b/RWSDocsTemplate/Plugins/System.Composition.Convention.dll
diff --git a/RWSDocsTemplate/Plugins/System.Composition.Hosting.dll b/RWSDocsTemplate/Plugins/System.Composition.Hosting.dll
diff --git a/RWSDocsTemplate/Plugins/System.Composition.Runtime.dll b/RWSDocsTemplate/Plugins/System.Composition.Runtime.dll
diff --git a/RWSDocsTemplate/Plugins/System.Composition.TypedParts.dll b/RWSDocsTemplate/Plugins/System.Composition.TypedParts.dll
diff --git a/RWSDocsTemplate/Plugins/System.Memory.dll b/RWSDocsTemplate/Plugins/System.Memory.dll
diff --git a/RWSDocsTemplate/Plugins/System.Numerics.Vectors.dll b/RWSDocsTemplate/Plugins/System.Numerics.Vectors.dll
diff --git a/RWSDocsTemplate/Plugins/System.Runtime.CompilerServices.Unsafe.dll b/RWSDocsTemplate/Plugins/System.Runtime.CompilerServices.Unsafe.dll
diff --git a/RWSDocsTemplate/Plugins/TradosStudioDocsPlugin.dll b/RWSDocsTemplate/Plugins/TradosStudioDocsPlugin.dll
diff --git a/RWSDocsTemplate/Plugins/TradosStudioDocsPlugin.pdb b/RWSDocsTemplate/Plugins/TradosStudioDocsPlugin.pdb
diff --git a/RWSDocsTemplate/Plugins/YamlDotNet.dll b/RWSDocsTemplate/Plugins/YamlDotNet.dll
diff --git a/RWSDocsTemplate/foo.txt b/RWSDocsTemplate/foo.txt
@@ -0,0 +1,3 @@
+{{!include(logo.svg)}}
+  <img id="logo" class="svg" src="{{_rel}}{{{_appLogoPath}}}{{^_appLogoPath}}logo.svg{{/_appLogoPath}}" alt="{{_appName}}" >
+  <img id="logo" class="svg" src="{{_rel}}logo.svg" alt="{{_appName}}" >
diff --git a/RWSDocsTemplate/partials/logo.tmpl.partial b/RWSDocsTemplate/partials/logo.tmpl.partial
@@ -1,5 +1,6 @@
 {{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}}
 
-<a class="navbar-brand" href="{{_rel}}index.html">
+<a class="navbar-brand" href="/index.html">
   <img id="logo" class="svg" src="{{_rel}}{{{_appLogoPath}}}{{^_appLogoPath}}logo.svg{{/_appLogoPath}}" alt="{{_appName}}" >
 </a>
+<a href="/index.html"><span class="page-logo">Developers</span></a>
diff --git a/RWSDocsTemplate/search-stopwords.json b/RWSDocsTemplate/search-stopwords.json
diff --git a/RWSDocsTemplate/styles/docfx.css b/RWSDocsTemplate/styles/docfx.css
@@ -345,6 +345,8 @@ article section {
 #autocollapse .navbar-header {
   margin-left: 0;
   margin-right: 2rem;
+  display: flex;
+  align-items: center;
 }
 
 #autocollapse .navbar-brand {

diff --git a/RWSDocsTemplate/styles/main.css b/RWSDocsTemplate/styles/main.css
diff --git a/RWSDocsTemplate/token.json b/RWSDocsTemplate/token.json
diff --git a/apiconcepts/Tridion_Docs_14SP3/overview.md b/apiconcepts/Tridion_Docs_14SP3/overview.md
@@ -1,4 +1,4 @@
-# Tridion Docs API Documentation #
+# Tridion Docs 14 SP3 API Documentation #
 ## [Content Manager API](https://docs.rws.com/806356/604329/sdl-tridion-docs-14-sp3/content-manager-api) ##
 This section contains information for developers to develop applications on top of the Content Manager web services API.
 

diff --git a/apiconcepts/overview.md b/apiconcepts/overview.md
@@ -1,4 +1,4 @@
-## [Learn more about Tridion Docs 14SP4 APIs](Tridion_Docs_14SP4/overview.html)
+## [Learn more about Tridion Docs 14SP4 APIs](Tridion_Docs_14SP4/overview.md)
 Learn more about the APIs and what you can achieve with them.
-## [Learn more about Tridion Docs 14SP3 APIs](Tridion_Docs_14SP3/overview.html)
+## [Learn more about Tridion Docs 14SP3 APIs](Tridion_Docs_14SP3/overview.md)
 Learn more about the APIs and what you can achieve with them.
diff --git a/docfx.json b/docfx.json
@@ -8,9 +8,6 @@
       },
       {
         "files": [
-          "articles/**.md",
-          "articles/**/toc.yml",
-          "toc.yml",
           "*.md"
         ]
       },
@@ -48,14 +45,14 @@
       "api/**.yml": ["csharp", "vb", "fsharp", "cpp"]
       }
     },
-    "template": [
-      "RWSDocsTemplate"
-    ],
+	"template": [
+		"RWSDocsTemplate"
+	],
     "postProcessors": [ "ExtractSearchIndex" ],
     "markdownEngineName": "dfm",
     "noLangKeyword": false,
     "keepFileLink": false,
     "cleanupCacheHistory": false,
     "disableGitFeatures": false
   }
-}
+}
diff --git a/docfx.json.backup b/docfx.json.backup
@@ -0,0 +1,58 @@
+{
+  "build": {
+    "content": [
+      {
+        "files": [
+          "api/**.yml"
+        ]
+      },
+      {
+        "files": [
+          "*.md"
+        ]
+      },
+      { 
+	      "files": [
+          "apiconcepts/**.md",
+          "apiconcepts/toc.yml"
+        ]
+      }
+    ],
+    "resource": [
+      {
+        "files": [
+          "**/images/**"
+        ]
+      }
+    ],
+    "overwrite": [
+      {
+        "files": [
+          "api/**.md"
+        ],
+        "exclude": [
+          "obj/**",
+          "_site/**"
+        ]
+      }
+    ],
+    "dest": "_site",
+    "globalMetadataFiles": [],
+    "fileMetadataFiles": [],
+    "filemetadata":
+    { 
+      "langs": {
+      "api/**.yml": ["csharp", "vb", "fsharp", "cpp"]
+      }
+    },
+    "template": [
+      "RWSDocsTemplate"
+    ],
+    "postProcessors": [ "ExtractSearchIndex" ],
+    "markdownEngineName": "dfm",
+    "noLangKeyword": false,
+    "keepFileLink": false,
+    "cleanupCacheHistory": false,
+    "disableGitFeatures": false
+  }
+}
diff --git a/docfx.yml b/docfx.yml
@@ -0,0 +1,3 @@
+template: https://github.com/docascode/template
+globalMetadata:
+  titleSuffix: My Awesome Website
diff --git a/foo.txt b/foo.txt
diff --git a/getting-started.md b/getting-started.md
@@ -0,0 +1,7 @@
+---
+title: Getting Started
+---
+
+# Getting Started
+
+Add an introduction here using [markdown](http://daringfireball.net/projects/markdown/).
diff --git a/index.html b/index.html
diff --git a/index.md b/index.md
@@ -1,4 +1,4 @@
-# Welcome to the Tridion Docs API documentation.
+# Welcome to the Tridion Docs API documentation
 
 Here you’ll find all the information you need to get started developing against your own instance of Tridion Docs. Discover quick guides explaining how to build, develop and deploy your app, plus hints and tips to help you make the most of our APIs.
 
@@ -8,11 +8,20 @@ To let us know what your suggested improvements are you can do this by using the
 
 
 
-## [Learn more about Tridion Docs 14SP4 APIs](apiconcepts/Tridion_Docs_14SP4/overview.md)
+## Current release: Tridion Docs 14 SP4
+
+[Learn more about the Tridion Docs 14SP4 APIs](apiconcepts/Tridion_Docs_14SP4/overview.md)
+
 Learn more about the APIs and what you can achieve with them.
-## [Learn more about Tridion Docs 14SP3 APIs](apiconcepts/Tridion_Docs_14SP3/overview.md)
+
+## Earlier releases
+
+### Tridion Docs 14 SP3
+[Learn more about the Tridion Docs 14SP3 APIs](apiconcepts/Tridion_Docs_14SP3/overview.md)
+
 Learn more about the APIs and what you can achieve with them.
 
 
 Good luck and happy developing!
-RWS
+
+RWS
diff --git a/toc.yml b/toc.yml
@@ -1,4 +1,2 @@
-- name: Articles
-  href: articles/
-- name: Tridion Docs APIs
-  href: apiconcepts/
+- name: Getting Started
+  href: getting-started.md