Move website to Material for MkDocs

cake-contrib · Dec 18, 2024 · aded225 · aded225
1 parent 62073f3
commit aded225
Show file tree

Hide file tree

Showing 254 changed files with 1,932 additions and 3,769 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,7 +1,3 @@
-# Project specific 
-
-BuildArtifacts/
-
 # Created by https://www.gitignore.io/api/cake,visualstudio
 
 ### Cake ###
@@ -304,4 +300,9 @@ __pycache__/
 # By default, sensitive information, such as encrypted password
 # should be stored in the .pubxml.user file.
 
-# End of https://www.gitignore.io/api/cake,visualstudio
+# End of https://www.gitignore.io/api/cake,visualstudio
+
+# Project specific 
+
+BuildArtifacts/
+docs/.cache/
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,3 +1,15 @@
 {
-    "dotnet.defaultSolution": "src\\Cake.Issues.sln"
+    "dotnet.defaultSolution": "src\\Cake.Issues.sln",
+    "yaml.schemas": {
+        "https://squidfunk.github.io/mkdocs-material/schema.json": "mkdocs.yml"
+    },
+    "yaml.customTags": [ 
+        "!ENV scalar",
+        "!ENV sequence",
+        "!relative scalar",
+        "tag:yaml.org,2002:python/name:material.extensions.emoji.to_svg",
+        "tag:yaml.org,2002:python/name:material.extensions.emoji.twemoji",
+        "tag:yaml.org,2002:python/name:pymdownx.superfences.fence_code_format",
+        "tag:yaml.org,2002:python/object/apply:pymdownx.slugs.slugify mapping"
+    ]
 }
diff --git a/docs/docs/blog/index.md b/docs/docs/blog/index.md
@@ -0,0 +1,2 @@
+# News
+
diff --git a/...2020-08-22-cake-issues-v0.9.0-released.md → ...2020-08-22-cake-issues-v0.9.0-released.md b/...2020-08-22-cake-issues-v0.9.0-released.md → ...2020-08-22-cake-issues-v0.9.0-released.md
@@ -1,11 +1,13 @@
 ---
 title: Cake Issues v0.9.0 Released
-category: Release Notes
+date: 2020-08-22
+categories:
+  - Release Notes
 ---
 
 Cake Issues version 0.9.0 has been released. This is a major release bringing a lot of new features across all addins.
 
-<!--excerpt-->
+<!-- more -->
 
 This post shows the highlights included in this release.
 For update instructions skip to [Updating from previous versions](#updating-from-previous-versions).
@@ -14,15 +16,15 @@ For update instructions skip to [Updating from previous versions](#updating-from
 
 People working on this release:
 
-* [AdmiringWorm](https://github.com/AdmiringWorm)
-* [christianbumann](https://github.com/christianbumann)
-* [eoehen](https://github.com/eoehen)
-* [gep13](https://github.com/gep13)
-* [janniksam](https://github.com/janniksam)
-* [mholo65](https://github.com/mholo65)
-* [pascalberger](https://github.com/pascalberger)
-* [Speeedy01](https://github.com/Speeedy01)
-* [jokay](https://github.com/jokay)
+* [AdmiringWorm](https://github.com/AdmiringWorm){target="_blank"}
+* [christianbumann](https://github.com/christianbumann){target="_blank"}
+* [eoehen](https://github.com/eoehen){target="_blank"}
+* [gep13](https://github.com/gep13){target="_blank"}
+* [janniksam](https://github.com/janniksam){target="_blank"}
+* [mholo65](https://github.com/mholo65){target="_blank"}
+* [pascalberger](https://github.com/pascalberger){target="_blank"}
+* [Speeedy01](https://github.com/Speeedy01){target="_blank"}
+* [jokay](https://github.com/jokay){target="_blank"}
 
 ## Full cross-platform support
 
@@ -31,10 +33,11 @@ While in previous versions most parts of Cake Issues was already targeting .NET
 .NET Core.
 With this release `Cake.Issues.Reporting.Generic` was ported to also run on .NET Core.
 
-The migration was done by [gep13](https://github.com/gep13) on his [Twitch stream](https://www.twitch.tv/gep13) and you
-can watch work done in [Stream 90 - Working on Cake.Issues.Recipe](https://www.youtube.com/watch?v=7roa5Q6KcrQ),
-[Stream 91 - Working on Cake.Issues.Reporting.Generic and Gazorator](https://www.youtube.com/watch?v=ocacOz3CxME) and
-[Stream 92 - Working on Cake.Issues.Reporting.Generic and Gazorator - Part 2](https://www.youtube.com/watch?v=P0IpkL9gUAE).
+The migration was done by [gep13](https://github.com/gep13){target="_blank"} on his
+[Twitch stream](https://www.twitch.tv/gep13){target="_blank"} and you
+can watch work done in [Stream 90 - Working on Cake.Issues.Recipe](https://www.youtube.com/watch?v=7roa5Q6KcrQ){target="_blank"},
+[Stream 91 - Working on Cake.Issues.Reporting.Generic and Gazorator](https://www.youtube.com/watch?v=ocacOz3CxME){target="_blank"} and
+[Stream 92 - Working on Cake.Issues.Reporting.Generic and Gazorator - Part 2](https://www.youtube.com/watch?v=P0IpkL9gUAE){target="_blank"}.
 
 ## Enhanced issue information
 
@@ -137,7 +140,7 @@ across all runs.
 [Cake.Issues.Recipe], the Cake Recipe script which you can integrate into your build script for easy integration of
 full feature issue management, has been updated to version 0.4.0, bringing all the new features of Cake.Issues 0.9.0.
 
-[Cake.Issues.Recipe]: ../docs/recipe/overview
+[Cake.Issues.Recipe]: ../documentation/recipe/overview
 
 ## Updating from previous versions
 
@@ -149,7 +152,7 @@ This section documents the most common changes which might be required:
     Older version are still supported for deserialization.
 * Cake.Issues.Markdownlint
   * `MarkdownlintLogFileFormat` alias has been renamed to `MarkdownlintV1LogFileFormat`
-    ([#116](https://github.com/cake-contrib/Cake.Issues.Markdownlint/issues/116)).
+    ([#116](https://github.com/cake-contrib/Cake.Issues.Markdownlint/issues/116){target="_blank"}).
 * Cake.Issues.PullRequest
   * `ReportIssuesToPullRequest` alias which accepts an issue provider, or a list of issue providers, and settings requires now settings of type
     `IReportIssuesToPullRequestFromIssueProviderSettings` instead of `ReportIssuesToPullRequestSettings` to
@@ -165,30 +168,30 @@ This section documents the most common changes which might be required:
   * `HtmlDxDataGridOption.FileLinkSettings` has been removed.
     File link settings can now be defined while reading the issues.
     For details see [File linking].
-    ([#265](https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/issues/265)).
+    ([#265](https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/issues/265){target="_blank"}).
   * `HtmlDxDataGridOption.JSZipLocation` has been split into `HtmlDxDataGridOption.JsZipLocation` and
     `HtmlDxDataGridOption.JsZipVersion`
-    ([#320](https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/issues/320)).
+    ([#320](https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/issues/320){target="_blank"}).
 * Cake.Issues.Recipe
   * Cake.Issues.Recipe requires at least Cake 0.38.0
 
 For details see release notes of the individual addins:
 
-* [Cake.Issues 0.9.0](https://github.com/cake-contrib/Cake.Issues/releases/tag/0.9.0)
-* [Cake.Issues.MsBuild 0.9.0](https://github.com/cake-contrib/Cake.Issues.MsBuild/releases/tag/0.9.0)
-* [Cake.Issues.InspectCode 0.9.0](https://github.com/cake-contrib/Cake.Issues.InspectCode/releases/tag/0.9.0)
-* [Cake.Issues.DupFinder 0.9.0](https://github.com/cake-contrib/Cake.Issues.DupFinder/releases/tag/0.9.0)
-* [Cake.Issues.GitRepository 0.9.0](https://github.com/cake-contrib/Cake.Issues.GitRepository/releases/tag/0.9.0)
-* [Cake.Issues.Markdownlint 0.9.0](https://github.com/cake-contrib/Cake.Issues.Markdownlint/releases/tag/0.9.0)
-* [Cake.Issues.EsLint 0.9.0](https://github.com/cake-contrib/Cake.Issues.EsLint/releases/tag/0.9.0)
-* [Cake.Issues.DocFx 0.9.0](https://github.com/cake-contrib/Cake.Issues.DocFx/releases/tag/0.9.0)
-* [Cake.Issues.PullRequests 0.9.0](https://github.com/cake-contrib/Cake.Issues.PullRequests/releases/tag/0.9.0)
-* [Cake.Issues.PullRequests.AzureDevOps 0.9.0](https://github.com/cake-contrib/Cake.Issues.PullRequests.AzureDevOps/releases/tag/0.9.0)
-* [Cake.Issues.PullRequests.AppVeyor 0.9.0](https://github.com/cake-contrib/Cake.Issues.PullRequests.AppVeyor/releases/tag/0.9.0)
-* [Cake.Issues.Reporting 0.9.0](https://github.com/cake-contrib/Cake.Issues.Reporting/releases/tag/0.9.0)
-* [Cake.Issues.Reporting.Generic 0.9.0](https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/releases/tag/0.9.0)
-* [Cake.Issues.Reporting.Sarif 0.9.0](https://github.com/cake-contrib/Cake.Issues.Reporting.Sarif/releases/tag/0.9.0)
-* [Cake.Issues.Recipe 0.4.0](https://github.com/cake-contrib/Cake.Issues.Recipe/releases/tag/0.4.0)
+* [Cake.Issues 0.9.0](https://github.com/cake-contrib/Cake.Issues/releases/tag/0.9.0){target="_blank"}
+* [Cake.Issues.MsBuild 0.9.0](https://github.com/cake-contrib/Cake.Issues.MsBuild/releases/tag/0.9.0){target="_blank"}
+* [Cake.Issues.InspectCode 0.9.0](https://github.com/cake-contrib/Cake.Issues.InspectCode/releases/tag/0.9.0){target="_blank"}
+* [Cake.Issues.DupFinder 0.9.0](https://github.com/cake-contrib/Cake.Issues.DupFinder/releases/tag/0.9.0){target="_blank"}
+* [Cake.Issues.GitRepository 0.9.0](https://github.com/cake-contrib/Cake.Issues.GitRepository/releases/tag/0.9.0){target="_blank"}
+* [Cake.Issues.Markdownlint 0.9.0](https://github.com/cake-contrib/Cake.Issues.Markdownlint/releases/tag/0.9.0){target="_blank"}
+* [Cake.Issues.EsLint 0.9.0](https://github.com/cake-contrib/Cake.Issues.EsLint/releases/tag/0.9.0){target="_blank"}
+* [Cake.Issues.DocFx 0.9.0](https://github.com/cake-contrib/Cake.Issues.DocFx/releases/tag/0.9.0){target="_blank"}
+* [Cake.Issues.PullRequests 0.9.0](https://github.com/cake-contrib/Cake.Issues.PullRequests/releases/tag/0.9.0){target="_blank"}
+* [Cake.Issues.PullRequests.AzureDevOps 0.9.0](https://github.com/cake-contrib/Cake.Issues.PullRequests.AzureDevOps/releases/tag/0.9.0){target="_blank"}
+* [Cake.Issues.PullRequests.AppVeyor 0.9.0](https://github.com/cake-contrib/Cake.Issues.PullRequests.AppVeyor/releases/tag/0.9.0){target="_blank"}
+* [Cake.Issues.Reporting 0.9.0](https://github.com/cake-contrib/Cake.Issues.Reporting/releases/tag/0.9.0){target="_blank"}
+* [Cake.Issues.Reporting.Generic 0.9.0](https://github.com/cake-contrib/Cake.Issues.Reporting.Generic/releases/tag/0.9.0){target="_blank"}
+* [Cake.Issues.Reporting.Sarif 0.9.0](https://github.com/cake-contrib/Cake.Issues.Reporting.Sarif/releases/tag/0.9.0){target="_blank"}
+* [Cake.Issues.Recipe 0.4.0](https://github.com/cake-contrib/Cake.Issues.Recipe/releases/tag/0.4.0){target="_blank"}
 
 [File linking]: #file-linking
 [Support for passing additional run information]: #support-for-passing-additional-run-information
diff --git a/...2020-09-19-cake-issues-v0.9.1-released.md → ...2020-09-19-cake-issues-v0.9.1-released.md b/...2020-09-19-cake-issues-v0.9.1-released.md → ...2020-09-19-cake-issues-v0.9.1-released.md
@@ -1,12 +1,14 @@
 ---
 title: Cake Issues v0.9.1 Released
-category: Release Notes
+date: 2020-09-19
+categories:
+  - Release Notes
 ---
 
 Version 0.9.1 of Cake Issues and Cake.Issues.PullRequests.AzureDevOps have been released.
 These are minor releases containing improvements and bug fixes.
 
-<!--excerpt-->
+<!-- more -->
 
 This post shows the highlights included in this release.
 For update instructions skip to [Updating from previous versions](#updating-from-previous-versions).
@@ -15,10 +17,10 @@ For update instructions skip to [Updating from previous versions](#updating-from
 
 People working on this release:
 
-* [christianbumann](https://github.com/christianbumann)
-* [janniksam](https://github.com/janniksam)
-* [pascalberger](https://github.com/pascalberger)
-* [jokay](https://github.com/jokay)
+* [christianbumann](https://github.com/christianbumann){target="_blank"}
+* [janniksam](https://github.com/janniksam){target="_blank"}
+* [pascalberger](https://github.com/pascalberger){target="_blank"}
+* [jokay](https://github.com/jokay){target="_blank"}
 
 ## Easier file linking for manually created issues
 
@@ -31,7 +33,7 @@ it become much more complicated for issues created using the `NewIssue` alias, w
 
 Cake.Issues 0.9.1 adds an `WithFileLinkSettings` method to `IIssueBuilder` where a file link setting object can be passed which does resolve the URL.
 
-[file link infrastructure was moved to Cake.Issues]: cake-issues-v0.9.0-released#file-linking
+[file link infrastructure was moved to Cake.Issues]: 2020-08-22-cake-issues-v0.9.0-released.md#file-linking
 
 ## Line range and column support in Azure DevOps pull request integration
 

diff --git a/docs/input/news/2020-09-24-annotations.png → ...ocs/blog/posts/2020-09-24-annotations.png b/docs/input/news/2020-09-24-annotations.png → ...ocs/blog/posts/2020-09-24-annotations.png
diff --git a/...-24-cake-issues-recipe-v0.4.2-released.md → ...-24-cake-issues-recipe-v0.4.2-released.md b/...-24-cake-issues-recipe-v0.4.2-released.md → ...-24-cake-issues-recipe-v0.4.2-released.md
@@ -1,11 +1,13 @@
 ---
 title: Cake Issues Recipe v0.4.2 released, bringing support for GitHub Actions
-category: Release Notes
+date: 2020-09-24
+categories:
+  - Release Notes
 ---
 
 Version 0.4.2 of Cake Issues Recipe has been released bringing support for GitHub Actions.
 
-<!--excerpt-->
+<!-- more -->
 
 This post shows the highlights included in this release.
 For update instructions skip to [Updating from previous versions](#updating-from-previous-versions).
@@ -14,8 +16,8 @@ For update instructions skip to [Updating from previous versions](#updating-from
 
 People working on this release:
 
-* [admiringworm](https://github.com/admiringworm)
-* [pascalberger](https://github.com/pascalberger)
+* [admiringworm](https://github.com/admiringworm){target="_blank"}
+* [pascalberger](https://github.com/pascalberger){target="_blank"}
 
 ## Support for GitHub Actions
 
@@ -34,10 +36,9 @@ Having issues available as annotations also means that they will be shown in pul
 
 It's planned to support remaining features like providing full issue report as artifact in a future release.
 
-:::{.alert .alert-info}
-Support for GitHub Actions integration is currently only available in Cake.Issues.Recipe, but not as a standalone addin.
-It's planned to additionally provide a standalone addin which can be used outside of Cake.Issues.Recipe in the future.
-:::
+!!! info
+    Support for GitHub Actions integration is currently only available in Cake.Issues.Recipe, but not as a standalone addin.
+    It's planned to additionally provide a standalone addin which can be used outside of Cake.Issues.Recipe in the future.
 
 ## Updating from previous versions
 

diff --git a/docs/input/news/2020-09-24-log-output.png → ...docs/blog/posts/2020-09-24-log-output.png b/docs/input/news/2020-09-24-log-output.png → ...docs/blog/posts/2020-09-24-log-output.png
diff --git a/...ws/2020-09-24-pullrequest-integration.png → ...ts/2020-09-24-pullrequest-integration.png b/...ws/2020-09-24-pullrequest-integration.png → ...ts/2020-09-24-pullrequest-integration.png
diff --git a/...t/news/2020-09-27-github-actions-addin.md → .../posts/2020-09-27-github-actions-addin.md b/...t/news/2020-09-27-github-actions-addin.md → .../posts/2020-09-27-github-actions-addin.md
@@ -1,23 +1,25 @@
 ---
 title: New GitHub Actions addin
-category: Release Notes
+date: 2020-09-27
+categories:
+  - Release Notes
 ---
 
 A new [Cake.Issues.PullRequest.GitHubActions addin] has been released which brings integration with GitHub Actions and GitHub pull requests.
 
-<!--excerpt-->
+<!-- more -->
 
 [Cake.Issues.PullRequest.GitHubActions addin] creates annotations from issues when running on GitHub Actions:
 
-![Annotations](../docs/pull-request-systems/github-actions/githubactions-annotations.png "Annotations")
+![Annotations](../../documentation/pull-request-systems/github-actions/githubactions-annotations.png "Annotations")
 
 These annotations will also be shown in pull requests on the related file / position,
 bringing first class integration for GitHub pull requests to Cake.Issues:
 
-![Pull request integration](../docs/pull-request-systems/github-actions/githubactions-pullrequest-integration.png "Pull request integration")
+![Pull request integration](../../documentation/pull-request-systems/github-actions/githubactions-pullrequest-integration.png "Pull request integration")
 
 This integration was [first released in Cake.Issues.Recipe 0.4.2] and has now been moved to its own addin, which can also be used outside of
 Cake.Issues.Recipe.
 
-[Cake.Issues.PullRequest.GitHubActions addin]: ../docs/pull-request-systems/github-actions/
-[first released in Cake.Issues.Recipe 0.4.2]: cake-issues-recipe-v0.4.2-released
+[Cake.Issues.PullRequest.GitHubActions addin]: ../../documentation/pull-request-systems/github-actions/index.md
+[first released in Cake.Issues.Recipe 0.4.2]: 2020-09-24-cake-issues-recipe-v0.4.2-released.md
diff --git a/...ke-issues-pullrequests-v0.9.1-released.md → ...ke-issues-pullrequests-v0.9.1-released.md b/...ke-issues-pullrequests-v0.9.1-released.md → ...ke-issues-pullrequests-v0.9.1-released.md
@@ -1,12 +1,14 @@
 ---
 title: Cake Issues PullRequests v0.9.1 Released
-category: Release Notes
+date: 2020-10-09
+categories:
+  - Release Notes
 ---
 
 Version 0.9.1 of Cake.Issues.PullRequests has been released.
 This is a minor releases containing bug fixes.
 
-<!--excerpt-->
+<!-- more -->
 
 This post shows the highlights included in this release.
 For update instructions skip to [Updating from previous versions](#updating-from-previous-versions).
@@ -15,9 +17,9 @@ For update instructions skip to [Updating from previous versions](#updating-from
 
 People working on this release:
 
-* [janniksam](https://github.com/janniksam)
-* [pascalberger](https://github.com/pascalberger)
-* [phlorian](https://github.com/phlorian)
+* [janniksam](https://github.com/janniksam){target="_blank"}
+* [pascalberger](https://github.com/pascalberger){target="_blank"}
+* [phlorian](https://github.com/phlorian){target="_blank"}
 
 ## Don't post issues if a provider limit is set to 0
 

diff --git a/...20-cake-issues-msbuild-v0.9.1-released.md → ...20-cake-issues-msbuild-v0.9.1-released.md b/...20-cake-issues-msbuild-v0.9.1-released.md → ...20-cake-issues-msbuild-v0.9.1-released.md
@@ -1,12 +1,14 @@
 ---
 title: Cake Issues MsBuild v0.9.1 Released
-category: Release Notes
+date: 2020-10-20
+categories:
+  - Release Notes
 ---
 
 Version 0.9.1 of MsBuild support for Cake.Issues has been released.
 This is a minor release containing improvements.
 
-<!--excerpt-->
+<!-- more -->
 
 This post shows the highlights included in this release.
 For update instructions skip to [Updating from previous versions](#updating-from-previous-versions).
@@ -15,10 +17,10 @@ For update instructions skip to [Updating from previous versions](#updating-from
 
 People working on this release:
 
-* [cho-trackman](https://github.com/cho-trackman)
-* [eoehen](https://github.com/eoehen)
-* [pascalberger](https://github.com/pascalberger)
-* [jokay](https://github.com/jokay)
+* [cho-trackman](https://github.com/cho-trackman){target="_blank"}
+* [eoehen](https://github.com/eoehen){target="_blank"}
+* [pascalberger](https://github.com/pascalberger){target="_blank"}
+* [jokay](https://github.com/jokay){target="_blank"}
 
 ## Support for reading of errors
 
@@ -27,9 +29,8 @@ Starting with version 0.9.1 it will also return errors.
 Reading of errors has been implemented for `MsBuildBinaryLogFileFormat` and `MsBuildXmlFileLoggerFormat`.
 For errors `IIssue.Priority` will be set to `IssuePriority.Error`.
 
-:::{.alert .alert-info}
-To keep previous behavior result after reading the issues can be filtered for `IIssue.Priority == IIssuePriority.Warning`.
-:::
+!!! info
+    To keep previous behavior result after reading the issues can be filtered for `IIssue.Priority == IIssuePriority.Warning`.
 
 ## Updating from previous versions
 

diff --git a/...-01-cake-issues-recipe-v0.4.4-released.md → ...-01-cake-issues-recipe-v0.4.4-released.md b/...-01-cake-issues-recipe-v0.4.4-released.md → ...-01-cake-issues-recipe-v0.4.4-released.md
@@ -1,26 +1,28 @@
 ---
 title: Cake Issues Recipe v0.4.4 released, bringing support for ESLint
-category: Release Notes
+date: 2020-12-01
+categories:
+  - Release Notes
 ---
 
 Version 0.4.4 of Cake Issues Recipe has been released bringing support for ESLint.
 
-<!--excerpt-->
+<!-- more -->
 
 This post shows the highlights included in this release.
 For update instructions skip to [Updating from previous versions](#updating-from-previous-versions).
-For details see [full release notes](https://github.com/cake-contrib/Cake.Issues.Recipe/releases/tag/0.4.4).
+For details see [full release notes](https://github.com/cake-contrib/Cake.Issues.Recipe/releases/tag/0.4.4){target="_blank"}.
 
 ❤ Huge thanks to our community! This release would not have been possible without your support and contributions! ❤
 
 People working on this release:
 
-* [pascalberger](https://github.com/pascalberger)
+* [pascalberger](https://github.com/pascalberger){target="_blank"}
 
 ## Support for ESLint
 
-This version of Cake.Issues.Recipe brings support for issues reported by [ESLint](https://eslint.org/).
-Currently supported are files generated using the [ESLint json formatter](https://eslint.org/docs/user-guide/formatters/#json)
+This version of Cake.Issues.Recipe brings support for issues reported by [ESLint](https://eslint.org/){target="_blank"}.
+Currently supported are files generated using the [ESLint json formatter](https://eslint.org/docs/user-guide/formatters/#json){target="_blank"}
 
 ## Updating from previous versions