Merge branch 'support-gh-pages-in-forks'

The purpose of this topic branch is to allow development of
https://github.com/git/git-scm.com/ to happen in forks and to be tested
in those forks' GitHub Pages.

Signed-off-by: Johannes Schindelin <[email protected]>

Author: dscho

.github/workflows/ci.yml

@@ -22,6 +22,16 @@ jobs:
     - name: run Hugo to build the pages
       run: hugo
 
+    - name: ensure that there are no absolute URLs
+      run: |
+        set -x
+        if git grep --untracked --no-exclude-standard "\\(href\|src\) *= *[\"']/" \
+          -- public/ ':^public/js/jquery*' >/tmp/abs-urls.txt
+        then
+          cat /tmp/abs-urls.txt
+          exit 1
+        fi
+
     - name: run Pagefind ${{ env.PAGEFIND_VERSION }} to build the search index
       run: npx -y pagefind@${{ env.PAGEFIND_VERSION }} --site public
 

assets/js/application.js

@@ -20,6 +20,13 @@
 popped = 'state' in window.history;
 initialURL = location.href;
 
+const baseURLPrefix = (() => {
+  const scripts = document.getElementsByTagName('script');
+  const index = scripts.length - 1;
+  const thisScript = scripts[index];
+  return thisScript.src.replace(/^.*:\/\/[^/]*(.*\/)js\/[^/]+.js(\?.*)?$/, '$1');
+})();
+
 $(document).ready(function() {
   BrowserFallbacks.init();
   Search.init();
@@ -49,27 +56,27 @@ var DownloadBox = {
     var os = window.session.browser.os; // Mac, Win, Linux
     if(os == "Mac") {
       $(".monitor").addClass("mac");
-      $("#download-link").text("Download for Mac").attr("href", "/download/mac");
+      $("#download-link").text("Download for Mac").attr("href", `${baseURLPrefix}download/mac`);
       $("#gui-link").removeClass('mac').addClass('gui');
-      $("#gui-link").text("Mac GUIs").attr("href", "/download/gui/mac");
+      $("#gui-link").text("Mac GUIs").attr("href", `${baseURLPrefix}download/gui/mac`);
       $("#gui-os-filter").attr('data-os', 'mac');
       $("#gui-os-filter").text("Only show GUIs for my OS (Mac)")
     } else if (os == "Windows") {
       $(".monitor").addClass("windows");
-      $("#download-link").text("Download for Windows").attr("href", "/download/win");
+      $("#download-link").text("Download for Windows").attr("href", `${baseURLPrefix}download/win`);
       $("#gui-link").removeClass('mac').addClass('gui');
-      $("#gui-link").text("Windows GUIs").attr("href", "/download/gui/windows");
+      $("#gui-link").text("Windows GUIs").attr("href", `${baseURLPrefix}download/gui/windows`);
       $("#alt-link").removeClass("windows").addClass("mac");
-      $("#alt-link").text("Mac Build").attr("href", "/download/mac");
+      $("#alt-link").text("Mac Build").attr("href", `${baseURLPrefix}download/mac`);
       $("#gui-os-filter").attr('data-os', 'windows');
       $("#gui-os-filter").text("Only show GUIs for my OS (Windows)")
     } else if (os == "Linux") {
       $(".monitor").addClass("linux");
-      $("#download-link").text("Download for Linux").attr("href", "/download/linux");
+      $("#download-link").text("Download for Linux").attr("href", `${baseURLPrefix}download/linux`);
       $("#gui-link").removeClass('mac').addClass('gui');
-      $("#gui-link").text("Linux GUIs").attr("href", "/download/gui/linux");
+      $("#gui-link").text("Linux GUIs").attr("href", `${baseURLPrefix}download/gui/linux`);
       $("#alt-link").removeClass("windows").addClass("mac");
-      $("#alt-link").text("Mac Build").attr("href", "/download/mac");
+      $("#alt-link").text("Mac Build").attr("href", `${baseURLPrefix}download/mac`);
       $("#gui-os-filter").attr('data-os', 'linux');
       $("#gui-os-filter").text("Only show GUIs for my OS (Linux)")
     } else {
@@ -257,7 +264,7 @@ var Search = {
     if(!url) {
       const term = $('#search-text').val();
       const language = document.querySelector("html")?.getAttribute("lang");
-      url = `search/results?search=${term}${language && `&language=${language}`}`;
+      url = `${baseURLPrefix}search/results?search=${term}${language && `&language=${language}`}`;
     }
     window.location.href = url;
     selectedIndex = 0;
@@ -417,8 +424,8 @@ var Downloads = {
 
       if (window.history && window.history.pushState) {
         var url = os === ''
-          ? '/downloads/guis/'
-          : `/download/guis?os=${os}`;
+          ? `${baseURLPrefix}downloads/guis`
+          : `${baseURLPrefix}download/guis?os=${os}`;
         try {
           history.pushState(null, $(this).html(), url);
         } catch (e) {

content/404.html

@@ -4,7 +4,7 @@
 
 <div class='inner'>
   <p>
-    <img src="/images/[email protected]" alt="404" width="456" height="149" />
+    <img src="{{< relurl "images/[email protected]" >}}" alt="404" width="456" height="149" />
   </p>
   <h1>That page doesn't exist.</h1>
   <p>

content/about/branching-and-merging.html

@@ -42,7 +42,7 @@ <h2>Branching and Merging</h2>
   </ul>
 
   <p class="center">
-    <img src="/images/about/[email protected]" width="500" height="288" alt="Branches">
+    <img src="{{< relurl "images/about/[email protected]" >}}" width="500" height="288" alt="Branches">
   </p>
 
   <p>
@@ -54,7 +54,7 @@ <h2>Branching and Merging</h2>
   </p>
 
   <div class="bottom-nav" style="display: block;">
-    <a href="/about/small-and-fast" class="next" data-section-id="small-and-fast">Small and Fast →</a>
+    <a href="{{< relurl "about/small-and-fast" >}}" class="next" data-section-id="small-and-fast">Small and Fast →</a>
   </div>
 
 </section>

content/about/data-assurance.html

@@ -17,7 +17,7 @@ <h2>Data Assurance</h2>
     checksum when checked back out. It's impossible to get anything out of Git
     other than the <strong>exact bits you put in</strong>.
     </p>
-    <img height="522" src="/images/[email protected]" width="628">
+    <img height="522" src="{{< relurl "images/[email protected]" >}}" width="628">
     <p>
     It is also impossible to change any file, date, commit message, or any other
     data in a Git repository without changing the IDs of everything after it.
@@ -29,8 +29,8 @@ <h2>Data Assurance</h2>
     Most centralized version control systems provide no such integrity by default.
     </p>
     <div class="bottom-nav" style="display: block;">
-      <a href="/about/distributed" class="previous" data-section-id="distributed">← Distributed</a>
-      <a href="/about/staging-area" class="next" data-section-id="staging-area">Staging Area →</a>
+      <a href="{{< relurl "about/distributed" >}}" class="previous" data-section-id="distributed">← Distributed</a>
+      <a href="{{< relurl "about/staging-area" >}}" class="next" data-section-id="staging-area">Staging Area →</a>
     </div>
   </section>
 

content/about/distributed.html

@@ -27,25 +27,25 @@ <h4>Subversion-Style Workflow</h4>
     A centralized workflow is very common, especially from people transitioning from a centralized system. Git will not allow you to push if someone has pushed since the last time you fetched, so a centralized model where all developers push to the same server works just fine.
     </p>
     <p class="center">
-    <img src="/images/about/[email protected]" width="415" height="209" alt="Workflow A">
+    <img src="{{< relurl "images/about/[email protected]" >}}" width="415" height="209" alt="Workflow A">
     </p>
     <h4>Integration Manager Workflow</h4>
     <p>
     Another common Git workflow involves an integration manager — a single person who commits to the 'blessed' repository. A number of developers then clone from that repository, push to their own independent repositories, and ask the integrator to pull in their changes. This is the type of development model often seen with open source or GitHub repositories.
     </p>
     <p class="center">
-    <img src="/images/about/[email protected]" width="407" height="164" alt="Workflow B">
+    <img src="{{< relurl "images/about/[email protected]" >}}" width="407" height="164" alt="Workflow B">
     </p>
     <h4>Dictator and Lieutenants Workflow</h4>
     <p>
     For more massive projects, a development workflow like that of the Linux kernel is often effective.
     In this model, some people ('lieutenants') are in charge of a specific subsystem of the project and they merge in all changes related to that subsystem. Another integrator (the 'dictator') can pull changes from only his/her lieutenants and then push to the 'blessed' repository that everyone then clones from again.
     </p>
     <p class="center">
-    <img src="/images/about/[email protected]" width="562" height="303" alt="Workflow C">
+    <img src="{{< relurl "images/about/[email protected]" >}}" width="562" height="303" alt="Workflow C">
     </p>
     <div class="bottom-nav" style="display: block;">
-      <a href="/about/small-and-fast" class="previous" data-section-id="small-and-fast">← Small and Fast</a>
-      <a href="/about/data-assurance" class="next" data-section-id="info-assurance">Data Assurance →</a>
+      <a href="{{< relurl "about/small-and-fast" >}}" class="previous" data-section-id="small-and-fast">← Small and Fast</a>
+      <a href="{{< relurl "about/data-assurance" >}}" class="next" data-section-id="info-assurance">Data Assurance →</a>
     </div>
   </section>

content/about/free-and-open-source.html

@@ -17,12 +17,12 @@ <h2>Free and Open Source</h2>
 	free for all its users.</p>
 
     <p>However, we do restrict the use of the term "Git" and the
-       <a href="/downloads/logos">logos</a> to avoid confusion. Please
-       see our <a href="/trademark">trademark</a> policy for
+       <a href="{{< relurl "downloads/logos" >}}">logos</a> to avoid confusion. Please
+       see our <a href="{{< relurl "trademark" >}}">trademark</a> policy for
        details.</p>
 
     <div class="bottom-nav" style="display: block;">
-      <a href="/about/staging-area" class="previous" data-section-id="staging-area">← Staging Area</a>
-      <a href="/about/trademark" class="next" data-section-id="trademark">Trademark →</a>
+      <a href="{{< relurl "about/staging-area" >}}" class="previous" data-section-id="staging-area">← Staging Area</a>
+      <a href="{{< relurl "about/trademark" >}}" class="next" data-section-id="trademark">Trademark →</a>
     </div>
   </section>

content/about/small-and-fast.html

@@ -155,8 +155,8 @@ <h3>Benchmarks</h3>
     </p>
 
     <div class="bottom-nav" style="display: block;">
-      <a href="/about/branching-and-merging" class="previous" data-section-id="branching-and-merging">← Branching and Merging</a>
-      <a href="/about/distributed" class="next" data-section-id="distributed">Distributed →</a>
+      <a href="{{< relurl "about/branching-and-merging" >}}" class="previous" data-section-id="branching-and-merging">← Branching and Merging</a>
+      <a href="{{< relurl "about/distributed" >}}" class="next" data-section-id="distributed">Distributed →</a>
     </div>
 
   </section>

content/about/staging-area.html

@@ -16,7 +16,7 @@ <h2>Staging Area</h2>
     One thing that sets Git apart from other tools is that it's possible to quickly stage some of your files and commit them without committing all of the other modified files in your working directory or having to list them on the command line during the commit.
     </p>
     <p class="center">
-    <img src="/images/about/[email protected]" width="336" height="194" alt="Index 1">
+    <img src="{{< relurl "images/about/[email protected]" >}}" width="336" height="194" alt="Index 1">
     </p>
     <p>
     This allows you to stage only portions of a modified file. Gone are the days of making two logically unrelated modifications to a file before you realized that you forgot to commit one of them. Now you can just stage the change you need for the current commit and stage the other change for the next commit. This feature scales up to as many different changes to your file as needed.
@@ -25,11 +25,11 @@ <h2>Staging Area</h2>
     Of course, Git also makes it easy to ignore this feature if you don't want that kind of control — just add a '-a' to your commit command in order to add all changes to all files to the staging area.
     </p>
     <p class="center">
-    <img src="/images/about/[email protected]" width="338" height="185" alt="Index 2">
+    <img src="{{< relurl "images/about/[email protected]" >}}" width="338" height="185" alt="Index 2">
     </p>
     <div class="bottom-nav" style="display: block;">
-      <a href="/about/data-assurance" class="previous" data-section-id="info-assurance">← Data Assurance</a>
-      <a href="/about/free-and-open-source" class="next" data-section-id="free-and-open-source">Free and Open Source →</a>
+      <a href="{{< relurl "about/data-assurance" >}}" class="previous" data-section-id="info-assurance">← Data Assurance</a>
+      <a href="{{< relurl "about/free-and-open-source" >}}" class="next" data-section-id="free-and-open-source">Free and Open Source →</a>
     </div>
   </section>
 

content/about/trademark.html

@@ -187,7 +187,7 @@ <h3>4 Questions</h3>
   Montague St.  Ste 380, Brooklyn, NY 11201-3548.</p>
 
   <div class="bottom-nav" style="display: block;">
-    <a href="/about/free-and-open-source" class="previous" data-section-id="free-and-open-source">← Free and Open Source</a>
+    <a href="{{< relurl "about/free-and-open-source" >}}" class="previous" data-section-id="free-and-open-source">← Free and Open Source</a>
   </div>
 
 </section>