Merge pull request #1 from block/myron/fix-site

Fix github pages site to use proper relative links.
block · Oct 25, 2024 · f2c5bf4 · f2c5bf4
2 parents e1c45df + c5f45ac
commit f2c5bf4
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 10 deletions.
diff --git a/config/site/Rakefile b/config/site/Rakefile
@@ -126,9 +126,17 @@ module ElasticGraph
           end
         end
 
+        common_jekyll_args = [
+          "--source #{SITE_SOURCE_DIR}",
+          "--destination #{JEKYLL_SITE_DIR}",
+          "--baseUrl /elasticgraph",
+          "--strict-front-matter",
+          "--trace"
+        ].join(" ")
+
         desc "Build Jekyll site with freshly generated YARD documentation"
         task build: [:build_docs, :build_css, "examples:compile_queries"] do
-          sh "bundle exec jekyll build --source #{SITE_SOURCE_DIR} --destination #{JEKYLL_SITE_DIR}"
+          sh "bundle exec jekyll build #{common_jekyll_args}"
         end
 
         desc "Serve Jekyll site locally"
@@ -170,7 +178,7 @@ module ElasticGraph
             end
           end
 
-          sh "bundle exec jekyll serve --source #{SITE_SOURCE_DIR} --destination #{JEKYLL_SITE_DIR} --trace"
+          sh "bundle exec jekyll serve #{common_jekyll_args}"
         end
 
         desc "Perform validations of the website, including doc tests and doc coverage"

diff --git a/config/site/src/_includes/navbar.html b/config/site/src/_includes/navbar.html
@@ -2,14 +2,14 @@
 <nav class="w-full py-4 bg-gray-200 dark:bg-gray-800 shadow">
   <div class="container mx-auto flex justify-between items-center px-4">
     <div class="text-xl flex items-center space-x-4">
-      <a href="/" class="font-bold hover:underline">ElasticGraph</a>
-      <a href="/docs/main" class="{{ site.style.link }}">Docs</a>
-      <a href="/query-api" class="{{ site.style.link }}">Query API</a>
+      <a href="{{ '/' | relative_url }}" class="font-bold hover:underline">ElasticGraph</a>
+      <a href="{{ '/docs/main' | relative_url }}" class="{{ site.style.link }}">Docs</a>
+      <a href="{{ '/query-api' | relative_url }}" class="{{ site.style.link }}">Query API</a>
     </div>
     <div>
       <a href="{{ site.github_url }}" target="_blank"
         class="{{ site.style.link }} mr-2">GitHub</a>
-      <a href="/about" class="{{ site.style.link }}">About</a>
+      <a href="{{ '/about' | relative_url }}" class="{{ site.style.link }}">About</a>
     </div>
   </div>
 
@@ -19,7 +19,7 @@
       <ol class="list-reset flex">
         {% if page.url != "/" %}
         <li>
-          <a href="/" class="hover:underline">Home</a>
+          <a href="{{ '/' | relative_url }}" class="hover:underline">Home</a>
         </li>
         {% endif %}
 
@@ -39,7 +39,7 @@
             {% if page.url == link %}
               {{ page_title }}
             {% else %}
-              <a href="{{ link }}" class="hover:underline capitalize">
+              <a href="{{ link | relative_url }}" class="hover:underline capitalize">
                 {{ page_title }}
               </a>
             {% endif %}

diff --git a/config/site/src/_includes/subpages.html b/config/site/src/_includes/subpages.html
@@ -7,7 +7,7 @@ <h3 class="text-2xl font-bold text-gray-800 dark:text-gray-200 mb-4">Subpages</h
       {% assign subpage_url_parts = subpage.url | split: '/' | size %}
       {% if subpage_url_parts == needed_subpage_part_count %}
         <li>
-          <a href="{{ subpage.url }}" class="text-blue-600 hover:text-blue-800 dark:text-blue-400 dark:hover:text-blue-600 transition-colors duration-300">
+          <a href="{{ subpage.url | relative_url }}" class="text-blue-600 hover:text-blue-800 dark:text-blue-400 dark:hover:text-blue-600 transition-colors duration-300">
             {{ subpage.subpage_title }}
           </a>
         </li>

diff --git a/config/site/src/index.html b/config/site/src/index.html
@@ -13,7 +13,7 @@ <h1 class="text-4xl font-extrabold mb-4">
       A general-purpose framework and platform for indexing, searching,
       grouping, and aggregating data.
     </p>
-    <a href="/docs/main"
+    <a href="{{ '/docs/main' | relative_url }}"
       class="inline-block bg-blue-600 dark:bg-blue-500 text-white py-2 px-4 rounded hover:bg-blue-500 dark:hover:bg-blue-400 transition">
       Documentation
     </a>