HydePHP v2.x Development

.phpstorm.meta.php

@@ -3,5 +3,7 @@
 namespace PHPSTORM_META {
     override(\app(0), map([
         'hyde' => \Hyde\Foundation\HydeKernel::class,
+        'navigation.main' => \Hyde\Framework\Features\Navigation\MainNavigationMenu::class,
+        'navigation.sidebar' => \Hyde\Framework\Features\Navigation\DocumentationSidebar::class,
     ]));
 }

_ide_helper.php

@@ -22,6 +22,11 @@
 /** @var string $routeKey The route key for the page being compiled/previewed */
 $routeKey = \Hyde\Support\Facades\Render::getRouteKey();
 
+// Variables available only to some page types
+
+/** @var \Hyde\Framework\Features\Navigation\DocumentationSidebar $sidebar */
+$sidebar = app('navigation.sidebar');
+
 // Facades (aliased in app/config.php)
 
 /** @mixin \Hyde\Foundation\HydeKernel */
@@ -35,7 +40,7 @@ class Features extends \Hyde\Facades\Features {}
 class Config extends \Hyde\Facades\Config {}
 /** @mixin \Illuminate\Filesystem\Filesystem */
 class Filesystem extends \Hyde\Facades\Filesystem {}
-class DataCollections extends \Hyde\Support\DataCollections {}
+class DataCollection extends \Hyde\Support\DataCollection {}
 class Includes extends \Hyde\Support\Includes {}
 /** @mixin \Hyde\Foundation\Kernel\RouteCollection */
 class Routes extends \Hyde\Foundation\Facades\Routes {}

app/config.php

@@ -73,6 +73,7 @@
         Hyde\Foundation\Providers\ConfigurationServiceProvider::class,
         Hyde\Framework\HydeServiceProvider::class,
         Hyde\Foundation\Providers\ViewServiceProvider::class,
+        Hyde\Foundation\Providers\NavigationServiceProvider::class,
         Hyde\Console\ConsoleServiceProvider::class,
     ],
 
@@ -96,13 +97,14 @@
         'Features' => \Hyde\Facades\Features::class,
         'Config' => \Hyde\Facades\Config::class,
         'Filesystem' => \Hyde\Facades\Filesystem::class,
+        'Navigation' => \Hyde\Facades\Navigation::class,
         'Routes' => \Hyde\Foundation\Facades\Routes::class,
         'HtmlPage' => \Hyde\Pages\HtmlPage::class,
         'BladePage' => \Hyde\Pages\BladePage::class,
         'MarkdownPage' => \Hyde\Pages\MarkdownPage::class,
         'MarkdownPost' => \Hyde\Pages\MarkdownPost::class,
         'DocumentationPage' => \Hyde\Pages\DocumentationPage::class,
-        'DataCollections' => \Hyde\Support\DataCollections::class,
+        'DataCollection' => \Hyde\Support\DataCollection::class,
         'Includes' => \Hyde\Support\Includes::class,
         'Feature' => \Hyde\Enums\Feature::class,
     ],

config/docs.php

@@ -30,49 +30,49 @@
         // When using a grouped sidebar, should the groups be collapsible?
         'collapsible' => true,
 
-        // Should the sidebar footer be shown? You can also set this to a string
-        // of Markdown to show in the footer. Set to `false` to disable.
-        'footer' => true,
-    ],
-
-    /*
-    |--------------------------------------------------------------------------
-    | Sidebar Page Order
-    |--------------------------------------------------------------------------
-    |
-    | In the generated Documentation pages the navigation links in the sidebar
-    | default to sort alphabetically. You can reorder the page identifiers
-    | in the list below, and the links will get sorted in that order.
-    |
-    | The items will get a priority of 500 plus the order its found in the list.
-    | Pages without a priority will fall back to the default priority of 999.
-    |
-    | You can also set explicit priorities in front matter or by specifying
-    | a value to the array key in the list to override the inferred value.
-    |
-    */
-
-    'sidebar_order' => [
-        'readme',
-        'installation',
-        'getting-started',
-    ],
-
-    /*
-    |--------------------------------------------------------------------------
-    | Table of Contents Settings
-    |--------------------------------------------------------------------------
-    |
-    | The Hyde Documentation Module comes with a fancy Sidebar that, by default,
-    | has a Table of Contents included. Here, you can configure its behavior,
-    | content, look and feel. You can also disable the feature completely.
-    |
-    */
+        // A string of Markdown to show in the footer. Set to `false` to disable.
+        'footer' => '[Back to home page](../)',
+
+        /*
+        |--------------------------------------------------------------------------
+        | Sidebar Page Order
+        |--------------------------------------------------------------------------
+        |
+        | In the generated Documentation pages the navigation links in the sidebar
+        | default to sort alphabetically. You can reorder the page identifiers
+        | in the list below, and the links will get sorted in that order.
+        |
+        | The items will get a priority of 500 plus the order its found in the list.
+        | Pages without a priority will fall back to the default priority of 999.
+        |
+        | You can also set explicit priorities in front matter or by specifying
+        | a value to the array key in the list to override the inferred value.
+        |
+        */
+
+        'order' => [
+            'readme',
+            'installation',
+            'getting-started',
+        ],
+
+        /*
+        |--------------------------------------------------------------------------
+        | Table of Contents Settings
+        |--------------------------------------------------------------------------
+        |
+        | The Hyde Documentation Module comes with a fancy Sidebar that, by default,
+        | has a Table of Contents included. Here, you can configure its behavior,
+        | content, look and feel. You can also disable the feature completely.
+        |
+        */
+
+        'table_of_contents' => [
+            'enabled' => true,
+            'min_heading_level' => 2,
+            'max_heading_level' => 4,
+        ],
 
-    'table_of_contents' => [
-        'enabled' => true,
-        'min_heading_level' => 2,
-        'max_heading_level' => 4,
     ],
 
     /*

config/hyde.php

@@ -23,8 +23,9 @@
 */
 
 use Hyde\Facades\Author;
-use Hyde\Enums\Feature;
 use Hyde\Facades\Meta;
+use Hyde\Enums\Feature;
+use Hyde\Facades\Navigation;
 
 return [
 
@@ -248,7 +249,6 @@
     |
     | Some of Hyde's features are optional. Feel free to disable the features
     | you don't need by removing or commenting them out from this array.
-    | This config concept is directly inspired by Laravel Jetstream.
     |
     */
 
@@ -278,17 +278,26 @@
     | However, it's tedious to have to add those to each and every
     | post you make, and keeping them updated is even harder.
     |
-    | Here you can add predefined authors. When writing posts,
-    | just specify the username in the front matter, and the
-    | rest of the data will be pulled from a matching entry.
+    | To solve this problem, you can add predefined authors with this setting.
+    | When writing posts just specify the author's username (the array key).
+    | Hyde will pull the matching data from here and fill in the blanks.
     |
     */
 
     'authors' => [
-        Author::create(
-            'mr_hyde', // Required username
-            'Mr. Hyde', // Optional display name
-            'https://hydephp.com' // Optional website URL
+        'mr_hyde' => Author::create(
+            // The following settings are used in the default blog post template.
+            name: 'Mr. Hyde', // Optional display name
+            website: 'https://hydephp.com', // Optional website URL
+
+            // The following settings are not used in the bundled templates,
+            // but you can use them in your own custom views, for example.
+            // bio: 'The mysterious author of HydePHP',
+            // avatar: 'avatar.png',
+            // socials: [
+            //     'twitter' => 'HydeFramework',
+            //     'github' => 'hydephp',
+            // ],
         ),
     ],
 
@@ -323,40 +332,23 @@
     |
     */
 
-    'navigation' => [
-        // This configuration sets the priorities used to determine the order of the menu.
-        // The default values have been added below for reference and easy editing.
-        // The array key is the page's route key, the value is the priority.
-        // Lower values show up first in the menu. The default is 999.
-        'order' => [
+    'navigation' => Navigation::configure()
+        ->setPagePriorities([
             'index' => 0,
             'posts' => 10,
             'docs/index' => 100,
-        ],
-
-        // In case you want to customize the labels for the menu items, you can do so here.
-        // Simply add the route key as the array key, and the label as the value.
-        'labels' => [
+        ])
+        ->setPageLabels([
             'index' => 'Home',
             'docs/index' => 'Docs',
-        ],
-
-        // These are the route keys of pages that should not show up in the navigation menu.
-        'exclude' => [
+        ])
+        ->excludePages([
             '404',
-        ],
-
-        // Any extra links you want to add to the navigation menu can be added here.
-        // To get started quickly, you can uncomment the defaults here.
-        // See the documentation link above for more information.
-        'custom' => [
-            // NavItem::forLink('https://github.com/hydephp/hyde', 'GitHub', 200),
-        ],
-
-        // How should pages in subdirectories be displayed in the menu?
-        // You can choose between 'dropdown', 'flat', and 'hidden'.
-        'subdirectories' => 'hidden',
-    ],
+        ])
+        ->addNavigationItems([
+            // Navigation::item('https://github.com/hydephp/hyde', 'GitHub', 200),
+        ])
+        ->setSubdirectoryDisplayMode('hidden'),
 
     /*
     |--------------------------------------------------------------------------

docs/_data/partials/hyde-pages-api/hyde-kernel-base-methods.md

@@ -1,7 +1,7 @@
 <section id="hyde-kernel-base-methods">
 
 <!-- Start generated docs for Hyde\Foundation\HydeKernel -->
-<!-- Generated by HydePHP DocGen script at 2024-07-08 20:47:38 in 2.89ms -->
+<!-- Generated by HydePHP DocGen script at 2024-07-09 07:44:59 in 3.36ms -->
 
 #### `version()`
 
@@ -32,7 +32,7 @@ Hyde::features(): Hyde\Facades\Features
 No description provided.
 
 ```php
-Hyde::hasFeature(Hyde\Enums\Feature|string $feature): bool
+Hyde::hasFeature(Hyde\Enums\Feature $feature): bool
 ```
 
 #### `toArray()`