Skip to content

Commit

Permalink
Update the navigation configuration documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
caendesilva committed Nov 6, 2023
1 parent ed14ee3 commit 135b008
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 14 deletions.
7 changes: 4 additions & 3 deletions config/docs.php
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,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.
|
*/

Expand Down
12 changes: 8 additions & 4 deletions config/hyde.php
Original file line number Diff line number Diff line change
Expand Up @@ -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',
],
Expand Down
7 changes: 4 additions & 3 deletions packages/framework/config/docs.php
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,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.
|
*/

Expand Down
12 changes: 8 additions & 4 deletions packages/framework/config/hyde.php
Original file line number Diff line number Diff line change
Expand Up @@ -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',
],
Expand Down

0 comments on commit 135b008

Please sign in to comment.