Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[2.x] Clean up the navigation and sidebar documentation #1838

Merged
Merged
Changes from 10 commits
Commits
Show all changes
45 commits
Select commit Hold shift + click to select a range
901b810
Create Claude draft
caendesilva Jul 12, 2024
d51c4af
Revert "Create Claude draft"
caendesilva Jul 12, 2024
3f9f9f8
Remove hard line breaks from sections
caendesilva Jul 12, 2024
7a85697
Remove extra newlines
caendesilva Jul 12, 2024
467b991
Cleanup line
caendesilva Jul 12, 2024
ac511db
Shorten line
caendesilva Jul 12, 2024
5f1e3e7
Merge branch 'unify-the-navigation-api' into clean-up-the-navigation-…
caendesilva Jul 12, 2024
326898b
Merge branch 'unify-the-navigation-api' into clean-up-the-navigation-…
caendesilva Jul 12, 2024
accc2f7
Clarify that lower priority values result in higher placement in the …
caendesilva Jul 12, 2024
cc0d2e3
Clean up section
caendesilva Jul 12, 2024
0df917b
Reformat table
caendesilva Jul 12, 2024
ab46ba4
Clarify that label is generated not literal
caendesilva Jul 12, 2024
ad504ac
Improve grouping documentation wording
caendesilva Jul 12, 2024
5aa2fa5
Fix wrong term used for sidebars
caendesilva Jul 12, 2024
cff03ac
Improve wording to be clearer
caendesilva Jul 12, 2024
c3fe8fb
Remove unnecessary line break
caendesilva Jul 12, 2024
9a2b2ef
Fix punctuation
caendesilva Jul 12, 2024
a7c6f8f
Clarify wording
caendesilva Jul 12, 2024
87eec33
Fix section order
caendesilva Jul 12, 2024
3fb32ab
Fix inline code formatting
caendesilva Jul 12, 2024
79ef5b2
Fix wrong page type name
caendesilva Jul 12, 2024
591ae52
Fix grammar
caendesilva Jul 12, 2024
a2bc307
Merge branch '2.x-dev' into clean-up-the-navigation-documentation
caendesilva Jul 12, 2024
3d3932d
Remove word that isn't to be there
caendesilva Jul 12, 2024
3f5a4dd
Add missing important word
caendesilva Jul 12, 2024
4b5c86d
Use American English
caendesilva Jul 12, 2024
f3c494e
Split out subordinate clause to separate sentence
caendesilva Jul 12, 2024
dc69f6a
Use APA style headings
caendesilva Jul 12, 2024
7021d23
Fix clarity
caendesilva Jul 12, 2024
1eb578c
Fix title formatting
caendesilva Jul 12, 2024
14c5ac6
Use shorter synonym
caendesilva Jul 12, 2024
18fafba
Remove comma from coupled clauses
caendesilva Jul 12, 2024
fcc030d
Reword line to be more fluent
caendesilva Jul 12, 2024
82aba3d
Merge branch '2.x-dev' into clean-up-the-navigation-documentation
caendesilva Jul 12, 2024
072dd83
Merge branch '2.x-dev' into clean-up-the-navigation-documentation
caendesilva Jul 12, 2024
714e941
Use plural wording to match other pluralized terms in sentence
caendesilva Jul 12, 2024
1bea0ef
Add missing infix
caendesilva Jul 12, 2024
d269f6a
Add comma between independent clauses
caendesilva Jul 12, 2024
74c4924
Fix typo should be a comma
caendesilva Jul 12, 2024
c00ab1b
Add missing word
caendesilva Jul 12, 2024
8129241
Remove comma from coupled clauses
caendesilva Jul 12, 2024
312135e
Change word order to be more fluent
caendesilva Jul 12, 2024
e46b837
Split out coupled clause to standalone sentence
caendesilva Jul 12, 2024
a5df67f
Reword to pluralize feature in introduction
caendesilva Jul 12, 2024
89fe3e0
Merge branch 'unify-the-navigation-api' into clean-up-the-navigation-…
caendesilva Jul 12, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions docs/creating-content/documentation-pages.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ navigation:

Welcome to the Hyde Documentation Pages, where creating professional-looking documentation sites has never been easier. Using the Hyde Documentation module, all you need to do is place standard Markdown files in the _docs/ directory, and Hyde takes care of the rest.

Hyde compiles your Markdown content into beautiful static HTML pages using a TailwindCSS frontend, complete with a responsive sidebar that is automatically generated based on your Markdown files. You can even customize the order, labels, and even groups, of the sidebar items to suit your needs.
Hyde compiles your Markdown content into beautiful static HTML pages using a TailwindCSS frontend, complete with a responsive sidebar that is automatically generated based on your Markdown files. You can even customize the order, labels, and groups of the sidebar items to suit your needs.

Additionally, if you have a `_docs/index.md` file, the sidebar header will link to it, and an automatically generated "Docs" link will be added to your site's main navigation menu, pointing to your documentation page.

Expand Down Expand Up @@ -93,15 +93,14 @@ Since this feature shares a lot of similarities and implementation details with

### Sidebar ordering

The sidebar is sorted/ordered by the `priority` property. The higher the priority the further down in the sidebar it will be. The default priority is 999. You can override the priority using the following front matter:
The sidebar is sorted/ordered by the `priority` property. The lower the priority value, the higher up in the sidebar it will be. The default priority is 999. You can override the priority using the following front matter:

```yaml
navigation:
priority: 5
```

You can also change the order in the Docs configuration file. See [the chapter in the customization page](customization#navigation-menu--sidebar) for more details. <br>
_I personally think the config route is easier as it gives an instant overview, however the first way is nice as well._
You can also change the order in the `config/docs.php` configuration file, which may be easier to manage for larger sites. See [the chapter in the customization page](customization#navigation-menu--sidebar) for more details.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This chapter does no longer have this information:

Navigation Menu & Sidebar

A great time-saving feature of HydePHP is the automatic navigation menu and documentation sidebar generation.
Hyde is designed to automatically configure these menus for you based on the content you have in your project.

Still, you will likely want to customize some parts of these menus, and thankfully, Hyde makes it easy to do so.

Customizing the navigation menu

  • To customize the navigation menu, use the setting navigation.order in the hyde.php config.
  • When customizing the navigation menu, you should use the route key of the page.

Learn more in the Navigation Menu documentation.

Customizing the documentation sidebar

  • To customize the sidebar, use the setting sidebar.order in the docs.php config.
  • When customizing the sidebar, can use the route key, or just the page identifier of the page.

Learn more in the Documentation Pages documentation.


### Sidebar labels

Expand Down Expand Up @@ -309,7 +308,7 @@ The feature is automatically enabled when you specify a base URL in the Docs con

### Configuration

As an example configuration, let's take a practical example of how HydePHP.com uses this feature.
Here's an example configuration from the official HydePHP.com documentation:

```php
// Filepath: config/docs.php
Expand Down