Try jekyll-relative-links

keveleigh · keveleigh · commit b31cc5d97fe7 · 2025-12-02T16:01:41.000-08:00
diff --git a/Pipelines/Scripts/prepare-pages.ps1 b/Pipelines/Scripts/prepare-pages.ps1
@@ -21,23 +21,71 @@ Copy-Item -Path (Join-Path $ProjectRoot "images" "*") -Destination $images -Recu
 Copy-Item -Path (Join-Path $ProjectRoot "org.mixedrealitytoolkit.standardassets" "Textures" "Logos" "MRTK_Logo_White.png") -Destination $images -Force
 Copy-Item -Path (Join-Path $ProjectRoot "org.mixedrealitytoolkit.standardassets" "Textures" "Logos" "IconMRTKLogo.png") -Destination $images -Force
 
-$indexDestination = Join-Path $docs "index.md"
-# Create home page, add front matter, and copy content
-New-Item -Path $indexDestination -ItemType File -Force -Value @"
+$destination = Join-Path $docs "index.md"
+# Create page, add front matter, and copy content
+New-Item -Path $destination -ItemType File -Force -Value @"
 ---
 title: Home
 nav_order: 1
 ---
 
 
 "@
-Add-Content -Path $indexDestination -Value (Get-Content -Path (Join-Path $ProjectRoot "README.md"))
+Add-Content -Path $destination -Value (Get-Content -Path (Join-Path $ProjectRoot "README.md"))
+
+$destination = Join-Path $docs "CONTRIBUTING.md"
+# Create page, add front matter, and copy content
+New-Item -Path $destination -ItemType File -Force -Value @"
+---
+title: Contributing
+parent: Home
+---
+
+
+"@
+Add-Content -Path $destination -Value (Get-Content -Path (Join-Path $ProjectRoot "CONTRIBUTING.md"))
+
+$destination = Join-Path $docs "LICENSE.md"
+# Create page, add front matter, and copy content
+New-Item -Path $destination -ItemType File -Force -Value @"
+---
+title: License
+parent: Home
+---
+
+
+"@
+Add-Content -Path $destination -Value (Get-Content -Path (Join-Path $ProjectRoot "LICENSE.md"))
+
+$destination = Join-Path $docs "MAINTAINERS.md"
+# Create page, add front matter, and copy content
+New-Item -Path $destination -ItemType File -Force -Value @"
+---
+title: Maintainers
+parent: Home
+---
+
+
+"@
+Add-Content -Path $destination -Value (Get-Content -Path (Join-Path $ProjectRoot "MAINTAINERS.md"))
+
+$destination = Join-Path $docs "GOVERNANCE.md"
+# Create page, add front matter, and copy content
+New-Item -Path $destination -ItemType File -Force -Value @"
+---
+title: Governance
+parent: Home
+---
+
+
+"@
+Add-Content -Path $destination -Value (Get-Content -Path (Join-Path $ProjectRoot "GOVERNANCE.md"))
 
 # Convert GitHub admonitions to just-the-docs syntax for in-place docs files
 # We leave them checked-in so they render correctly in the GitHub repo, but we convert them for Pages
 Get-ChildItem -Path (Join-Path $docs "*" "*.md") -Recurse | ForEach-Object {
     $fileContent = Get-Content -Path $_
-    Set-Content -Path $_ -Value ($fileContent -replace "> \[!(\w+)\]", { "{: .$("$($_.Groups[1])".ToLower()) }" })
+    Set-Content -Path $_ -Value ($fileContent -replace "> \[!(\w+)\]", { "{: .$("$($_.Groups[1])".ToLower()) }" } -replace "/docs/", "/")
 }
 
 # Loop through package directories and copy documentation
diff --git a/README.md b/README.md
@@ -92,10 +92,10 @@ To help identify specific packages and their versions, MRTK3 provides an about d
 
 This project welcomes contributions, suggestions, and feedback. All contributions, suggestions, and feedback you submitted are accepted under the [Project's license](./LICENSE.md). You represent that if you do not own copyright in the code that you have the authority to submit it under the [Project's license](./LICENSE.md). All feedback, suggestions, or contributions are not confidential.
 
-For more information on how to contribute Mixed Reality Toolkit for Unity Project, please read [CONTRIBUTING.md](./CONTRIBUTING.md).
+For more information on how to contribute Mixed Reality Toolkit for Unity Project, please read the [Contributing document](./CONTRIBUTING.md).
 
 ## Governance
 
-For information on how the Mixed Reality Toolkit for Unity Project is governed, please read [GOVERNANCE.md](./GOVERNANCE.md).
+For information on how the Mixed Reality Toolkit for Unity Project is governed, please read the [Governance document](./GOVERNANCE.md).
 
 All projects under the Mixed Reality Toolkit organization are governed by the Steering Committee. The Steering Committee is responsible for all technical oversight, project approval and oversight, policy oversight, and trademark management for the Organization. To learn more about the Steering Committee, visit this link: <https://github.com/MixedRealityToolkit/MixedRealityToolkit-MVG/blob/main/org-docs/CHARTER.md>
diff --git a/docs/Gemfile b/docs/Gemfile
@@ -2,3 +2,4 @@ source 'https://rubygems.org'
 
 gem "jekyll", "~> 4.4.1"
 gem "just-the-docs", "0.10.1"
+gem 'jekyll-relative-links', '~> 0.7.0'
diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock
@@ -1,24 +1,20 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.8.7)
-      public_suffix (>= 2.0.2, < 7.0)
-    base64 (0.2.0)
-    bigdecimal (3.1.9)
+    addressable (2.8.8)
+      public_suffix (>= 2.0.2, < 8.0)
+    base64 (0.3.0)
+    bigdecimal (3.3.1)
     colorator (1.1.0)
     concurrent-ruby (1.3.5)
-    csv (3.3.2)
+    csv (3.3.5)
     em-websocket (0.5.3)
       eventmachine (>= 0.12.9)
       http_parser.rb (~> 0)
     eventmachine (1.2.7)
-    ffi (1.17.1-arm64-darwin)
-    ffi (1.17.1-x86_64-linux-gnu)
+    ffi (1.17.2-x86_64-linux-gnu)
     forwardable-extended (2.6.0)
-    google-protobuf (4.29.3-arm64-darwin)
-      bigdecimal
-      rake (>= 13)
-    google-protobuf (4.29.3-x86_64-linux)
+    google-protobuf (4.33.1-x86_64-linux-gnu)
       bigdecimal
       rake (>= 13)
     http_parser.rb (0.8.0)
@@ -45,13 +41,15 @@ GEM
       webrick (~> 1.7)
     jekyll-include-cache (0.2.1)
       jekyll (>= 3.7, < 5.0)
-    jekyll-sass-converter (3.0.0)
-      sass-embedded (~> 1.54)
+    jekyll-relative-links (0.7.0)
+      jekyll (>= 3.3, < 5.0)
+    jekyll-sass-converter (3.1.0)
+      sass-embedded (~> 1.75)
     jekyll-seo-tag (2.8.0)
       jekyll (>= 3.8, < 5.0)
     jekyll-watch (2.2.1)
       listen (~> 3.0)
-    json (2.9.1)
+    json (2.16.0)
     just-the-docs (0.10.1)
       jekyll (>= 3.8.5)
       jekyll-include-cache
@@ -68,30 +66,28 @@ GEM
     mercenary (0.4.0)
     pathutil (0.16.2)
       forwardable-extended (~> 2.6)
-    public_suffix (6.0.1)
-    rake (13.2.1)
+    public_suffix (7.0.0)
+    rake (13.3.1)
     rb-fsevent (0.11.2)
     rb-inotify (0.11.1)
       ffi (~> 1.0)
-    rexml (3.4.0)
-    rouge (4.5.1)
+    rexml (3.4.4)
+    rouge (4.6.1)
     safe_yaml (1.0.5)
-    sass-embedded (1.83.4-arm64-darwin)
-      google-protobuf (~> 4.29)
-    sass-embedded (1.83.4-x86_64-linux-gnu)
-      google-protobuf (~> 4.29)
+    sass-embedded (1.94.2-x86_64-linux-gnu)
+      google-protobuf (~> 4.31)
     terminal-table (3.0.2)
       unicode-display_width (>= 1.1.1, < 3)
     unicode-display_width (2.6.0)
-    webrick (1.9.1)
+    webrick (1.9.2)
 
 PLATFORMS
-  arm64-darwin
   x86_64-linux-gnu
 
 DEPENDENCIES
   jekyll (~> 4.4.1)
+  jekyll-relative-links (~> 0.7.0)
   just-the-docs (= 0.10.1)
 
 BUNDLED WITH
-   2.5.9
+   2.4.20
diff --git a/docs/_config.yml b/docs/_config.yml
@@ -7,6 +7,13 @@ url: https://mixedrealitytoolkit.github.io/MixedRealityToolkit-Unity/
 logo: "/images/MRTK_Logo_White.png"
 favicon_ico: "/images/IconMRTKLogo.png"
 
+plugins:
+  - jekyll-relative-links
+relative_links:
+  enabled: true
+  collections: true
+include: [ 'CONTRIBUTING.md', 'LICENSE.md', '**/CHANGELOG.md' ,'GOVERNANCE.md']
+
 defaults:
   - scope:
       path: "" # an empty string here means all files in the project

Original file line number	Diff line number	Diff line change
`@@ -2,3 +2,4 @@ source 'https://rubygems.org'`
`2`	`2`
`3`	`3`	`gem "jekyll", "~> 4.4.1"`
`4`	`4`	`gem "just-the-docs", "0.10.1"`
	`5`	`+gem 'jekyll-relative-links', '~> 0.7.0'`