Merge pull request #236 from hydephp/develop

HydePHP v1.4.0 - 2023-12-11

README.md

@@ -93,7 +93,8 @@ Development is made in the HydePHP Monorepo, which you can find here https://git
 
 ### Security
 
-If you discover any security-related issues, please email [email protected] instead of using the issue tracker.
+If you discover any security-related issues, please email [email protected] instead of using the issue tracker,
+or use the GitHub [Security Advisory](https://github.com/hydephp/develop/security/advisories) page.
 All vulnerabilities will be promptly addressed.
 
 ### Credits

composer.json

@@ -25,11 +25,11 @@
     ],
     "require": {
         "php": "^8.1",
-        "hyde/framework": "^1.3",
+        "hyde/framework": "^1.4",
         "laravel-zero/framework": "^10.0"
     },
     "require-dev": {
-        "hyde/realtime-compiler": "^3.1"
+        "hyde/realtime-compiler": "^3.2"
     },
     "autoload": {
         "psr-4": {

config/docs.php

@@ -30,7 +30,8 @@
         // When using a grouped sidebar, should the groups be collapsible?
         'collapsible' => true,
 
-        // Should the sidebar footer be shown?
+        // 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,
     ],
 
@@ -43,10 +44,11 @@
     | default to sort alphabetically. You can reorder the page identifiers
     | in the list below, and the links will get sorted in that order.
     |
-    | Internally, the items listed will get a position priority of 500 + the order its found in the list.
-    | Link items without an entry here will have fall back to the default priority of 999, putting them last.
+    | 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.
+    | 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.
     |
     */
 

config/hyde.php

@@ -300,27 +300,31 @@
     |
     | If you are looking to customize the main navigation menu, this is the place!
     |
+    | All these settings uses Route Keys to identify the page you want to configure.
+    | A route key is simply the URL path to the page, without the file extension.
+    | So `_site/posts/hello-world.html` has the route key 'posts/hello-world'.
+    |
     */
 
     '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 should match the page's route key (slug).
-        // Lower values show up first in the menu.
+        // 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' => [
             '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 (slug) as the key, and the label as the value.
+        // Simply add the route key as the array key, and the label as the value.
         'labels' => [
             'index' => 'Home',
             'docs/index' => 'Docs',
         ],
 
-        // These are the pages that should not show up in the navigation menu.
+        // These are the route keys of pages that should not show up in the navigation menu.
         'exclude' => [
             '404',
         ],
@@ -414,6 +418,9 @@
         // Should preview pages be saved to the output directory?
         'save_preview' => true,
 
+        // Should the live edit feature be enabled?
+        'live_edit' => env('SERVER_LIVE_EDIT', true),
+
         // Configure the realtime compiler dashboard
         'dashboard' => [
             // Should the realtime compiler dashboard be enabled?

package.json

@@ -5,30 +5,6 @@
         "prod": "mix --production",
         "watch": "mix watch"
     },
-    "name": "hyde",
-    "description": "Elegant and Powerful Static App Builder",
-    "version": "1.1.0",
-    "main": "hyde",
-    "directories": {
-        "test": "tests"
-    },
-    "repository": {
-        "type": "git",
-        "url": "git+https://github.com/hydephp/hyde.git"
-    },
-    "keywords": [
-        "hydephp",
-        "hyde",
-        "static",
-        "site",
-        "generator"
-    ],
-    "author": "Caen De Silva",
-    "license": "MIT",
-    "bugs": {
-        "url": "https://github.com/hydephp/hyde/issues"
-    },
-    "homepage": "https://hydephp.com",
     "devDependencies": {
         "@tailwindcss/typography": "^0.5.2",
         "autoprefixer": "^10.4.5",