Skip to content

Add Redirect Feature or Error Documentation Links #134

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jun 3, 2025
Merged

Add Redirect Feature or Error Documentation Links #134

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
009d48b
Include the errors directory when building
AristurtleDev Jun 3, 2025
6603e11
Add example error page for redirect
AristurtleDev Jun 3, 2025
1c8fc10
Use `redirect` and not `redirect_url`
AristurtleDev Jun 3, 2025
cfac5de
Replace `.md` in redirect url with `.html`
AristurtleDev Jun 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docfx.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@
"foundation/**/*.md",
"roadmap/**/*.md",
"roadmap/**/*.yml",
"errors/**/*.md",
"toc.yml",
"*.md"
],
Expand Down
5 changes: 5 additions & 0 deletions errors/setupwine/index.md
View file
Open in desktop
Original file line number Diff 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)
4 changes: 4 additions & 0 deletions templates/monogame/conceptual.extension.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions templates/monogame/layout/_master.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down Expand Up @@ -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>
6 changes: 3 additions & 3 deletions templates/monogame/partials/redirect.tmpl.partial
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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>