From 791392354b7511ee61cc80d28f76d090cc512863 Mon Sep 17 00:00:00 2001
From: Shitong Luo <luost26@gmail.com>
Date: Wed, 17 Jul 2024 17:06:56 +0800
Subject: [PATCH] Add URL debug message shown when `baseurl` is not configured
 correctly

---
 _config.yml                              |  3 +--
 _includes/widgets/url_debug_message.html | 23 +++++++++++++++++++++++
 index.html                               |  2 ++
 3 files changed, 26 insertions(+), 2 deletions(-)
 create mode 100644 _includes/widgets/url_debug_message.html

diff --git a/_config.yml b/_config.yml
index 1a455838..6bf21de0 100644
--- a/_config.yml
+++ b/_config.yml
@@ -13,8 +13,7 @@
 # you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.
 # You can create any custom variable you would like, and they will be accessible
 # in the templates via {{ site.myvariable }}.
-baseurl: "" # the subpath of your site, e.g. /blog
-url: "" # the base hostname & protocol for your site, e.g. http://example.com
+baseurl: "/" # the subpath of your site, e.g. /blog
 
 # Build settings
 markdown: kramdown
diff --git a/_includes/widgets/url_debug_message.html b/_includes/widgets/url_debug_message.html
new file mode 100644
index 00000000..ad2fc9f1
--- /dev/null
+++ b/_includes/widgets/url_debug_message.html
@@ -0,0 +1,23 @@
+<div id="url-debug-message" class="row mt-3 d-none">
+    <div class="col">
+        <div class="alert alert-warning my-0" role="alert">
+            <h5><i class="fas fa-exclamation-triangle"></i> Action required</h5>
+            <strong>Problem:</strong>
+            The current root path of this site is <code class="root-path-text"></code>,
+            which does not match the <code>baseurl</code> (<code>{{ site.baseurl }}</code>) configured in <code>_config.yml</code>.
+            <br>
+
+            <strong>Solution:</strong>
+            Please set the <code>baseurl</code> in <code>_config.yml</code> to "<code class="root-path-text"></code>".
+        </div>
+    </div>
+</div>
+
+<script>
+if(location.pathname != "{{ site.baseurl }}"){
+    document.getElementById("url-debug-message").classList.remove('d-none');
+}
+document.querySelectorAll(".root-path-text").forEach(function(element){
+    element.textContent = location.pathname;
+});
+</script>
diff --git a/index.html b/index.html
index 41e8f70a..81d4be57 100644
--- a/index.html
+++ b/index.html
@@ -6,6 +6,8 @@
 ---
 {% include widgets/profile_card.html %}
 
+{% include widgets/url_debug_message.html %}
+
 {% if site.data.display.homepage.show_experience %}
 {% include widgets/experience_card.html %}
 {% endif %}