Add Redirect Feature or Error Documentation Links (#134)

AristurtleDev · web-flow · commit 2dc81cd49c12 · 2025-06-03T19:45:03.000+01:00
* Include the errors directory when building

* Add example error page for redirect

* Use `redirect` and not `redirect_url`
`redirect_url` bypasses the conceptual processing since it runs an internal built in process within docfx to generate the redirect page.

* Replace `.md` in redirect url with `.html`
diff --git a/docfx.json b/docfx.json
@@ -40,6 +40,7 @@
           "foundation/**/*.md",
           "roadmap/**/*.md",
           "roadmap/**/*.yml",
+          "errors/**/*.md",
           "toc.yml",
           "*.md"
         ],
diff --git a/errors/setupwine/index.md b/errors/setupwine/index.md
@@ -0,0 +1,5 @@
+---
+redirect: ../../articles/tutorials/building_2d_games/02_getting_started/index.md?tabs=windows#setup-wine-for-effect-compilation-macos-and-linux-only
+---
+
+[url_validation](../../articles/tutorials/building_2d_games/02_getting_started/index.md?tabs=windows#setup-wine-for-effect-compilation-macos-and-linux-only)
diff --git a/templates/monogame/conceptual.extension.js b/templates/monogame/conceptual.extension.js
@@ -3,6 +3,10 @@
  */
 exports.preTransform = function (model) {
 
+       // Handle redirect urls that end with .md
+       if(model.redirect) {
+        model.redirect = model.redirect.replace(/\.md/g, '.html');
+    }
     
     //  For layout pages, ignore injecting title and description as header and
     //  first paragraph
diff --git a/templates/monogame/layout/_master.tmpl b/templates/monogame/layout/_master.tmpl
@@ -2,11 +2,11 @@
 {{!include(/^public/.*/)}}
 <!DOCTYPE html>
 <html {{#_lang}}lang="{{_lang}}"{{/_lang}}>
-{{#redirect_url}}
+{{#redirect}}
   {{>partials/redirect}}
-{{/redirect_url}}
+{{/redirect}}
 
-{{^redirect_url}}
+{{^redirect}}
   <head>
     {{>partials/head}}
   </head>
@@ -81,5 +81,5 @@
       <script type="text/javascript" src="/public/injectDonateButton.js"></script>
       <script type="text/javascript" src="/public/questionAnswer.js"></script>
   </body>
-{{/redirect_url}}
+{{/redirect}}
 </html>
diff --git a/templates/monogame/partials/redirect.tmpl.partial b/templates/monogame/partials/redirect.tmpl.partial
@@ -1,8 +1,8 @@
 <meta charset="utf-8"/>
 <title>Redirecting&hellip;</title>
 <link rel="canonical" href="{{ redirect.to | url }}"/>
-<script>location = '{{redirect_url}}';</script>
-<meta http-equiv="refresh" content="0; url={{redirect_url}}"/>
+<script>location = '{{redirect}}';</script>
+<meta http-equiv="refresh" content="0; url={{redirect}}"/>
 <meta name="robots" content="noindex"/>
 <h1>Redirecting&hellip;</h1>
-<a href="{{redirect_url}}">Click here if you are not redirected.</a>
+<a href="{{redirect}}">Click here if you are not redirected.</a>

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +redirect: ../../articles/tutorials/building_2d_games/02_getting_started/index.md?tabs=windows#setup-wine-for-effect-compilation-macos-and-linux-only
 +---
++
 +[url_validation](../../articles/tutorials/building_2d_games/02_getting_started/index.md?tabs=windows#setup-wine-for-effect-compilation-macos-and-linux-only)