[docs] Add proper jekyll plugins for redirects

For some reason, this initially worked without the plugin, but now it needs it. The plugin fixes the redirects
aptos-labs · Feb 20, 2024 · d1d3cef · d1d3cef
1 parent a5ad809
commit d1d3cef
Show file tree

Hide file tree

Showing 7 changed files with 25 additions and 13 deletions.
diff --git a/docs/404.html b/docs/404.html
@@ -21,4 +21,5 @@ <h1>404</h1>
 
   <p><strong>Page not found :(</strong></p>
   <p>The requested page could not be found.</p>
+  <p>Please go to the <a href="./index.md">documentation index</a></p>
 </div>
diff --git a/docs/@aptos-labs/index.md b/docs/@aptos-labs/index.md
@@ -1,5 +1,4 @@
 ---
 permalink: /@aptos-labs
-redirect_to:
-  - ./ts-sdk-latest
+redirect_to: /@aptos-labs/ts-sdk-latest
 ---
diff --git a/docs/@aptos-labs/ts-sdk-latest/index.md b/docs/@aptos-labs/ts-sdk-latest/index.md
@@ -1,5 +1,5 @@
 ---
-permalink: /ts-sdk-latest
-redirect_to:
-  - ../ts-sdk-1.7.0
+title: Latest Aptos TypeScript SDK Documentation
+permalink: /@aptos-labs/ts-sdk-latest
+redirect_to: /@aptos-labs/ts-sdk-1.7.0
 ---
diff --git a/docs/Gemfile b/docs/Gemfile
@@ -13,6 +13,7 @@ gem "jekyll", "~> 4.3.2"
 # uncomment the line below. To upgrade, run `bundle update github-pages`.
 # gem "github-pages", group: :jekyll_plugins
 # If you have any plugins, put them here!
+gem 'jekyll-redirect-from'
 
 # Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
 # and associated library.

diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock
@@ -1,21 +1,21 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.8.5)
+    addressable (2.8.6)
       public_suffix (>= 2.0.2, < 6.0)
     colorator (1.1.0)
-    concurrent-ruby (1.2.2)
+    concurrent-ruby (1.2.3)
     em-websocket (0.5.3)
       eventmachine (>= 0.12.9)
       http_parser.rb (~> 0)
     eventmachine (1.2.7)
     ffi (1.16.3)
     forwardable-extended (2.6.0)
-    google-protobuf (3.24.4-arm64-darwin)
+    google-protobuf (3.25.3-arm64-darwin)
     http_parser.rb (0.8.0)
     i18n (1.14.1)
       concurrent-ruby (~> 1.0)
-    jekyll (4.3.2)
+    jekyll (4.3.3)
       addressable (~> 2.4)
       colorator (~> 1.0)
       em-websocket (~> 0.5)
@@ -31,6 +31,8 @@ GEM
       safe_yaml (~> 1.0)
       terminal-table (>= 1.8, < 4.0)
       webrick (~> 1.7)
+    jekyll-redirect-from (0.16.0)
+      jekyll (>= 3.3, < 5.0)
     jekyll-sass-converter (3.0.0)
       sass-embedded (~> 1.54)
     jekyll-watch (2.2.1)
@@ -46,26 +48,28 @@ GEM
     mercenary (0.4.0)
     pathutil (0.16.2)
       forwardable-extended (~> 2.6)
-    public_suffix (5.0.3)
+    public_suffix (5.0.4)
     rb-fsevent (0.11.2)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
     rexml (3.2.6)
-    rouge (4.1.3)
+    rouge (4.2.0)
     safe_yaml (1.0.5)
-    sass-embedded (1.69.3-arm64-darwin)
-      google-protobuf (~> 3.23)
+    sass-embedded (1.71.0-arm64-darwin)
+      google-protobuf (~> 3.25)
     terminal-table (3.0.2)
       unicode-display_width (>= 1.1.1, < 3)
     unicode-display_width (2.5.0)
     webrick (1.8.1)
 
 PLATFORMS
   arm64-darwin-22
+  arm64-darwin-23
 
 DEPENDENCIES
   http_parser.rb (~> 0.6.0)
   jekyll (~> 4.3.2)
+  jekyll-redirect-from
   tzinfo (>= 1, < 3)
   tzinfo-data
   wdm (~> 0.1.1)

diff --git a/docs/_config.yml b/docs/_config.yml
@@ -22,6 +22,10 @@ title: Aptos TypeScript SDK Documentation
 description: >- # this means to ignore newlines until "baseurl:"
   Aptos TypeScript SDK documentation by version.
 
+remote_theme: pages-themes/minimal@v0.2.0
+plugins:
+  - jekyll-remote-theme
+  - jekyll-redirect-from
 # Build settings
 
 # Exclude from processing.

diff --git a/docs/index.md b/docs/index.md
@@ -1,4 +1,7 @@
 ---
+title: Aptos TypeScript SDK Documentation (@aptos-labs/ts-sdk)
+redirect_from:
+  - /@aptos-labs
 ---
 
 ## SDK Versions