diff --git a/.vs/ProjectSettings.json b/.vs/ProjectSettings.json new file mode 100644 index 0000000..f8b4888 --- /dev/null +++ b/.vs/ProjectSettings.json @@ -0,0 +1,3 @@ +{ + "CurrentProjectSetting": null +} \ No newline at end of file diff --git a/.vs/VSWorkspaceState.json b/.vs/VSWorkspaceState.json new file mode 100644 index 0000000..153d2e4 --- /dev/null +++ b/.vs/VSWorkspaceState.json @@ -0,0 +1,8 @@ +{ + "ExpandedNodes": [ + "", + "\\RWSDocsTemplate" + ], + "SelectedNode": "\\RWSDocsTemplate", + "PreviewInSolutionExplorer": false +} \ No newline at end of file diff --git a/.vs/slnx.sqlite b/.vs/slnx.sqlite new file mode 100644 index 0000000..80b6610 Binary files /dev/null and b/.vs/slnx.sqlite differ 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 new file mode 100644 index 0000000..7a99442 --- /dev/null +++ b/.vs/tridion-docs-api-docs-top-banner-update/config/applicationhost.config @@ -0,0 +1,1025 @@ + + + + + + + +
+
+
+
+
+
+
+
+ + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+
+ +
+
+
+
+
+
+ +
+
+
+
+
+ +
+
+
+ +
+
+ +
+
+ +
+
+
+ + +
+
+
+
+
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/.vs/tridion-docs-api-docs-top-banner-update/v16/.suo b/.vs/tridion-docs-api-docs-top-banner-update/v16/.suo new file mode 100644 index 0000000..6a45854 Binary files /dev/null and b/.vs/tridion-docs-api-docs-top-banner-update/v16/.suo differ diff --git a/RWSDocsTemplate/Plugins/HtmlAgilityPack.dll b/RWSDocsTemplate/Plugins/HtmlAgilityPack.dll deleted file mode 100644 index 0d67049..0000000 Binary files a/RWSDocsTemplate/Plugins/HtmlAgilityPack.dll and /dev/null differ diff --git a/RWSDocsTemplate/Plugins/HtmlAgilityPack.pdb b/RWSDocsTemplate/Plugins/HtmlAgilityPack.pdb deleted file mode 100644 index ebc0bf0..0000000 Binary files a/RWSDocsTemplate/Plugins/HtmlAgilityPack.pdb and /dev/null differ diff --git a/RWSDocsTemplate/Plugins/Microsoft.DocAsCode.Common.dll b/RWSDocsTemplate/Plugins/Microsoft.DocAsCode.Common.dll deleted file mode 100644 index 8e7efc0..0000000 Binary files a/RWSDocsTemplate/Plugins/Microsoft.DocAsCode.Common.dll and /dev/null differ diff --git a/RWSDocsTemplate/Plugins/Microsoft.DocAsCode.Dfm.dll b/RWSDocsTemplate/Plugins/Microsoft.DocAsCode.Dfm.dll deleted file mode 100644 index c23d650..0000000 Binary files a/RWSDocsTemplate/Plugins/Microsoft.DocAsCode.Dfm.dll and /dev/null differ diff --git a/RWSDocsTemplate/Plugins/Microsoft.DocAsCode.MarkdownLite.dll b/RWSDocsTemplate/Plugins/Microsoft.DocAsCode.MarkdownLite.dll deleted file mode 100644 index d2ac63c..0000000 Binary files a/RWSDocsTemplate/Plugins/Microsoft.DocAsCode.MarkdownLite.dll and /dev/null differ diff --git a/RWSDocsTemplate/Plugins/Microsoft.DocAsCode.Plugins.dll b/RWSDocsTemplate/Plugins/Microsoft.DocAsCode.Plugins.dll deleted file mode 100644 index dc77b33..0000000 Binary files a/RWSDocsTemplate/Plugins/Microsoft.DocAsCode.Plugins.dll and /dev/null differ diff --git a/RWSDocsTemplate/Plugins/Microsoft.DocAsCode.YamlSerialization.dll b/RWSDocsTemplate/Plugins/Microsoft.DocAsCode.YamlSerialization.dll deleted file mode 100644 index c8f7a56..0000000 Binary files a/RWSDocsTemplate/Plugins/Microsoft.DocAsCode.YamlSerialization.dll and /dev/null differ diff --git a/RWSDocsTemplate/Plugins/Newtonsoft.Json.dll b/RWSDocsTemplate/Plugins/Newtonsoft.Json.dll deleted file mode 100644 index be6558d..0000000 Binary files a/RWSDocsTemplate/Plugins/Newtonsoft.Json.dll and /dev/null differ diff --git a/RWSDocsTemplate/Plugins/System.Buffers.dll b/RWSDocsTemplate/Plugins/System.Buffers.dll deleted file mode 100644 index f2d83c5..0000000 Binary files a/RWSDocsTemplate/Plugins/System.Buffers.dll and /dev/null differ diff --git a/RWSDocsTemplate/Plugins/System.Collections.Immutable.dll b/RWSDocsTemplate/Plugins/System.Collections.Immutable.dll deleted file mode 100644 index f5513ca..0000000 Binary files a/RWSDocsTemplate/Plugins/System.Collections.Immutable.dll and /dev/null differ diff --git a/RWSDocsTemplate/Plugins/System.Composition.AttributedModel.dll b/RWSDocsTemplate/Plugins/System.Composition.AttributedModel.dll deleted file mode 100644 index 4acc216..0000000 Binary files a/RWSDocsTemplate/Plugins/System.Composition.AttributedModel.dll and /dev/null differ diff --git a/RWSDocsTemplate/Plugins/System.Composition.Convention.dll b/RWSDocsTemplate/Plugins/System.Composition.Convention.dll deleted file mode 100644 index ef3669b..0000000 Binary files a/RWSDocsTemplate/Plugins/System.Composition.Convention.dll and /dev/null differ diff --git a/RWSDocsTemplate/Plugins/System.Composition.Hosting.dll b/RWSDocsTemplate/Plugins/System.Composition.Hosting.dll deleted file mode 100644 index a446fe6..0000000 Binary files a/RWSDocsTemplate/Plugins/System.Composition.Hosting.dll and /dev/null differ diff --git a/RWSDocsTemplate/Plugins/System.Composition.Runtime.dll b/RWSDocsTemplate/Plugins/System.Composition.Runtime.dll deleted file mode 100644 index a05bfe9..0000000 Binary files a/RWSDocsTemplate/Plugins/System.Composition.Runtime.dll and /dev/null differ diff --git a/RWSDocsTemplate/Plugins/System.Composition.TypedParts.dll b/RWSDocsTemplate/Plugins/System.Composition.TypedParts.dll deleted file mode 100644 index cfae95d..0000000 Binary files a/RWSDocsTemplate/Plugins/System.Composition.TypedParts.dll and /dev/null differ diff --git a/RWSDocsTemplate/Plugins/System.Memory.dll b/RWSDocsTemplate/Plugins/System.Memory.dll deleted file mode 100644 index 5d19470..0000000 Binary files a/RWSDocsTemplate/Plugins/System.Memory.dll and /dev/null differ diff --git a/RWSDocsTemplate/Plugins/System.Numerics.Vectors.dll b/RWSDocsTemplate/Plugins/System.Numerics.Vectors.dll deleted file mode 100644 index 0865972..0000000 Binary files a/RWSDocsTemplate/Plugins/System.Numerics.Vectors.dll and /dev/null differ diff --git a/RWSDocsTemplate/Plugins/System.Runtime.CompilerServices.Unsafe.dll b/RWSDocsTemplate/Plugins/System.Runtime.CompilerServices.Unsafe.dll deleted file mode 100644 index de9e124..0000000 Binary files a/RWSDocsTemplate/Plugins/System.Runtime.CompilerServices.Unsafe.dll and /dev/null differ diff --git a/RWSDocsTemplate/Plugins/TradosStudioDocsPlugin.dll b/RWSDocsTemplate/Plugins/TradosStudioDocsPlugin.dll deleted file mode 100644 index c28fc7c..0000000 Binary files a/RWSDocsTemplate/Plugins/TradosStudioDocsPlugin.dll and /dev/null differ diff --git a/RWSDocsTemplate/Plugins/TradosStudioDocsPlugin.pdb b/RWSDocsTemplate/Plugins/TradosStudioDocsPlugin.pdb deleted file mode 100644 index c18d872..0000000 Binary files a/RWSDocsTemplate/Plugins/TradosStudioDocsPlugin.pdb and /dev/null differ diff --git a/RWSDocsTemplate/Plugins/YamlDotNet.dll b/RWSDocsTemplate/Plugins/YamlDotNet.dll deleted file mode 100644 index 0fa67e1..0000000 Binary files a/RWSDocsTemplate/Plugins/YamlDotNet.dll and /dev/null differ diff --git a/RWSDocsTemplate/foo.txt b/RWSDocsTemplate/foo.txt new file mode 100644 index 0000000..e705482 --- /dev/null +++ b/RWSDocsTemplate/foo.txt @@ -0,0 +1,3 @@ +{{!include(logo.svg)}} + + diff --git a/RWSDocsTemplate/partials/logo.tmpl.partial b/RWSDocsTemplate/partials/logo.tmpl.partial index 8209615..dfeac7a 100644 --- 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.}} - + + diff --git a/RWSDocsTemplate/search-stopwords.json b/RWSDocsTemplate/search-stopwords.json deleted file mode 100644 index 0bdcc2c..0000000 --- a/RWSDocsTemplate/search-stopwords.json +++ /dev/null @@ -1,121 +0,0 @@ -[ - "a", - "able", - "about", - "across", - "after", - "all", - "almost", - "also", - "am", - "among", - "an", - "and", - "any", - "are", - "as", - "at", - "be", - "because", - "been", - "but", - "by", - "can", - "cannot", - "could", - "dear", - "did", - "do", - "does", - "either", - "else", - "ever", - "every", - "for", - "from", - "get", - "got", - "had", - "has", - "have", - "he", - "her", - "hers", - "him", - "his", - "how", - "however", - "i", - "if", - "in", - "into", - "is", - "it", - "its", - "just", - "least", - "let", - "like", - "likely", - "may", - "me", - "might", - "most", - "must", - "my", - "neither", - "no", - "nor", - "not", - "of", - "off", - "often", - "on", - "only", - "or", - "other", - "our", - "own", - "rather", - "said", - "say", - "says", - "she", - "should", - "since", - "so", - "some", - "than", - "that", - "the", - "their", - "them", - "then", - "there", - "these", - "they", - "this", - "tis", - "to", - "too", - "twas", - "us", - "wants", - "was", - "we", - "were", - "what", - "when", - "where", - "which", - "while", - "who", - "whom", - "why", - "will", - "with", - "would", - "yet", - "you", - "your" -] diff --git a/RWSDocsTemplate/styles/docfx.css b/RWSDocsTemplate/styles/docfx.css index 3c3780b..1da9710 100644 --- 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 index 150cabc..67ad7ba 100644 --- a/RWSDocsTemplate/styles/main.css +++ b/RWSDocsTemplate/styles/main.css @@ -342,6 +342,16 @@ body { } } +/* Copied over from the developers.rws.com front page's combo.css file */ +.navbar-header .page-logo { + font-size: 22px; + font-weight: 700; + color: #979FB2; + margin-left: 1rem; +} + + + figure { margin: 0; } diff --git a/RWSDocsTemplate/token.json b/RWSDocsTemplate/token.json deleted file mode 100644 index e29e78c..0000000 --- a/RWSDocsTemplate/token.json +++ /dev/null @@ -1,62 +0,0 @@ -{ - "namespacesInSubtitle": "Namespaces", - "classesInSubtitle": "Classes", - "structsInSubtitle": "Structs", - "interfacesInSubtitle": "Interfaces", - "enumsInSubtitle": "Enums", - "delegatesInSubtitle": "Delegates", - "constructorsInSubtitle": "Constructors", - "fieldsInSubtitle": "Fields", - "propertiesInSubtitle": "Properties", - "methodsInSubtitle": "Methods", - "eventsInSubtitle": "Events", - "operatorsInSubtitle": "Operators", - "eiisInSubtitle": "Explicit Interface Implementations", - "functionsInSubtitle": "Functions", - "variablesInSubtitle": "Variables", - "typeAliasesInSubtitle": "Type Aliases", - "membersInSubtitle": "Members", - "improveThisDoc": "Improve this Doc", - "viewSource": "View Source", - "inheritance": "Inheritance", - "inheritedMembers": "Inherited Members", - "package": "Package", - "namespace": "Namespace", - "assembly": "Assembly", - "syntax": "Syntax", - "overrides": "Overrides", - "implements": "Implements", - "remarks": "Remarks", - "examples": "Examples", - "seealso": "See Also", - "declaration": "Declaration", - "parameters": "Parameters", - "typeParameters": "Type Parameters", - "type": "Type", - "name": "Name", - "description": "Description", - "returns": "Returns", - "fieldValue": "Field Value", - "propertyValue": "Property Value", - "eventType": "Event Type", - "variableValue": "Variable Value", - "typeAliasType": "Type Alias Type", - "exceptions": "Exceptions", - "condition": "Condition", - "extensionMethods": "Extension Methods", - "note": "
Note
", - "warning": "
Warning
", - "tip": "
Tip
", - "important": "
Important
", - "caution": "
Caution
", - "tocToggleButton": "Show / Hide Table of Contents", - "tocFilter": "Enter here to filter...", - "search": "Search", - "searchResults": "Search Results for", - "pageFirst": "First", - "pagePrev": "Previous", - "pageNext": "Next", - "pageLast": "Last", - "inThisArticle": "On this page", - "backToTop": "Back to top" -} diff --git a/apiconcepts/Tridion_Docs_14SP3/overview.md b/apiconcepts/Tridion_Docs_14SP3/overview.md index b490da6..0cb37a1 100644 --- 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 index 0cd7caf..db482cb 100644 --- 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 index 745d1b3..6ee7c8b 100644 --- a/docfx.json +++ b/docfx.json @@ -8,9 +8,6 @@ }, { "files": [ - "articles/**.md", - "articles/**/toc.yml", - "toc.yml", "*.md" ] }, @@ -48,9 +45,9 @@ "api/**.yml": ["csharp", "vb", "fsharp", "cpp"] } }, - "template": [ - "RWSDocsTemplate" - ], + "template": [ + "RWSDocsTemplate" + ], "postProcessors": [ "ExtractSearchIndex" ], "markdownEngineName": "dfm", "noLangKeyword": false, @@ -58,4 +55,4 @@ "cleanupCacheHistory": false, "disableGitFeatures": false } -} \ No newline at end of file +} diff --git a/docfx.json.backup b/docfx.json.backup new file mode 100644 index 0000000..9d7813d --- /dev/null +++ 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 new file mode 100644 index 0000000..7fc8a2f --- /dev/null +++ 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 new file mode 100644 index 0000000..e69de29 diff --git a/getting-started.md b/getting-started.md new file mode 100644 index 0000000..9bfaec8 --- /dev/null +++ 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 deleted file mode 100644 index 8b13789..0000000 --- a/index.html +++ /dev/null @@ -1 +0,0 @@ - diff --git a/index.md b/index.md index 01e6c78..8c31895 100644 --- 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 \ No newline at end of file diff --git a/toc.yml b/toc.yml index 65418cd..fc96f54 100644 --- 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