Rewrite index docs path to pretty url, fix #353

Author: caendesilva

resources/views/layouts/docs.blade.php

@@ -14,7 +14,7 @@
 	<nav id="mobile-navigation">
 		<strong class="mr-auto">
 			@if(Hyde::docsIndexPath() !== false)
-			<a href="{{ basename(Hyde::docsIndexPath()) }}">
+			<a href="{{ Hyde::relativeLink(Hyde::docsIndexPath(), $currentPage) }}">
 				{{ config('hyde.docsSidebarHeaderTitle', 'Documentation') }}
 			</a>
 			@else
@@ -34,7 +34,7 @@
 			<div id="sidebar-brand">
 				<strong>
 					@if(Hyde::docsIndexPath() !== false)
-					<a href="{{ basename(Hyde::docsIndexPath()) }}">
+					<a href="{{ Hyde::relativeLink(Hyde::docsIndexPath(), $currentPage) }}">
 						{{ config('hyde.docsSidebarHeaderTitle', 'Documentation') }}
 					</a>
 					@else

src/Concerns/Internal/FileHelpers.php

@@ -85,6 +85,9 @@ public static function pageLink(string $destination): string
                 if ($destination === 'index.html') {
                     return '/';
                 }
+                if ($destination === static::docsDirectory().'/index.html') {
+                    return static::docsDirectory().'/';
+                }
 
                 return substr($destination, 0, -5);
             }

tests/Unit/FileHelperPageLinkPrettyUrlTest.php

@@ -80,4 +80,16 @@ public function test_helper_does_not_rewrite_index_when_not_using_pretty_urls()
         config(['hyde.prettyUrls' => false]);
         $this->assertEquals('index.html', Hyde::pageLink('index.html'));
     }
+
+    public function test_helper_rewrites_documentation_page_index_when_using_pretty_urls()
+    {
+        config(['hyde.prettyUrls' => true]);
+        $this->assertEquals('docs/', Hyde::pageLink('docs/index.html'));
+    }
+
+    public function test_helper_does_not_rewrite_documentation_page_index_when_not_using_pretty_urls()
+    {
+        config(['hyde.prettyUrls' => false]);
+        $this->assertEquals('docs/index.html', Hyde::pageLink('docs/index.html'));
+    }
 }

tests/Unit/FileHelperRelativeLinkTest.php

@@ -99,4 +99,13 @@ public function test_helper_does_not_rewrite_index_when_not_using_pretty_urls()
         $this->assertEquals('../index.html', Hyde::relativeLink('index.html', 'foo/bar.html'));
         $this->assertEquals('../../index.html', Hyde::relativeLink('index.html', 'foo/bar/baz.html'));
     }
+
+    public function test_helper_rewrites_documentation_page_index_when_using_pretty_urls()
+    {
+        config(['hyde.prettyUrls' => true]);
+        $this->assertEquals('docs/', Hyde::relativeLink('docs/index.html', 'foo.html'));
+        $this->assertEquals('docs/', Hyde::relativeLink('docs/index.html', 'docs.html'));
+        $this->assertEquals('../docs/', Hyde::relativeLink('docs/index.html', 'foo/bar.html'));
+        $this->assertEquals('../docs/', Hyde::relativeLink('docs/index.html', 'docs/foo.html'));
+    }
 }