HydePHP v1.7.0 - 2024-07-05

[caendesilva]

Version v1.7.0 - 2024-07-05

Added

• Added support for using HTML comments to create Markdown code block filepath labels in Add custom filepath label support for HTML comments #1693
• Added a config option to disable the theme toggle buttons to automatically use browser settings in Add a config option to disable theme toggle buttons to automatically use browser settings #1697
• You can now specify which path to open when using the --open option in the serve command in Update realtime compiler open flag to support specifying the page to open #1694
• Added a --format=json option to the route:list command in Add a JSON output format option to the route list command #1724

Changed

• When a navigation group is set in front matter, it will now be used regardless of the subdirectory configuration in [1.x] Honour front matter navigation groups set in front matter regardless of subdirectory setting #1703 (fixes When setting nagivation groups for standard pages in front matter the dropdown subdirectory setting is required #1515)
• Use late static bindings to support overriding data collections file finding in Use late static bindings to support overriding data collections file finding #1717 (fixes DataCollections file finding method can't be overriden #1716)
• Method Hyde::hasSiteUrl() now returns false if the site URL is for localhost in Improve behaviour when a site URL is not explicitly set #1726
• Method Hyde::url() will now return a relative URL instead of throwing an exception when supplied a path even if the site URL is not set in Improve behaviour when a site URL is not explicitly set #1726
• Updated the .env.example file to contain more details on the site URL setting's usages in Update site URL documentation to contain more details on its usages #1746
• Added a version prefix to the sitemap's generator attribute in Add a version prefix to the sitemap generator version attribute #1767
• Setting a site name in the Yaml config file will now influence all configuration values where this is used, unless already set, in Improve the Yaml configuration loader #1770 and Refactor bootstrappers and improve Yaml environment configuration loading #1773

Deprecated

• Deprecated the global unslash() function, replaced with the existing namespaced \Hyde\unslash() function in [1.x] Deprecate the global unslash function #1753
• Deprecated the BaseUrlNotSetException class in [1.x] Deprecate the BaseUrlNotSetException class #1759

Removed

• The Git version is no longer displayed in the debug screen and dashboard in Remove the Git version displays #1756

Fixed

• Fixed explicitly set front matter navigation group behavior being dependent on subdirectory configuration, fixing When setting nagivation groups for standard pages in front matter the dropdown subdirectory setting is required #1515 in [1.x] Honour front matter navigation groups set in front matter regardless of subdirectory setting #1703
• Fixed DataCollections file finding method not being able to be overridden DataCollections file finding method can't be overriden #1716 in Use late static bindings to support overriding data collections file finding #1717
• Fixed PHP warning when trying to parse a Markdown file with just front matter without body Undefined array key exception when creating Markdown pages with only front matter and no Markdown #1705 in Fix undefined array key exception for empty Markdown pages #1728
• Fixed [2.x] Should we add a version prefix to the generator string? #1748 by normalizing generator version prefixes in Add a version prefix to the sitemap generator version attribute #1767
• Yaml data files no longer need to start with triple dashes to be parsed by DataCollections in [1.x] DataCollections improvements #1733
• Updated the Hyde URL helper to not modify already qualified URLs in Update the Hyde URL helper to not modify already qualified URLs #1757

Extra information

This release contains changes to how HydePHP behaves when a site URL is not set by the user.

These changes are made to reduce the chance of the default localhost value showing up in production environments.

Most notably, HydePHP now considers that default site URL localhost to mean that a site URL is not set, as the user has not set it.
This means that things like automatic canonical URLs will not be added, as Hyde won't know how to make them without a site URL.
The previous behaviour was that Hyde used localhost in canonical URLs, which is never useful in production environments.

For this reason, we felt it worth it to make this change in a minor release, as it has a such large benefit for sites.

You can read more about the details and design decisions of this change in the following pull request #1726.

[caendesilva]

Claude: Announcing HydePHP v1.7: Enhancing Flexibility and User Experience

We're excited to announce the release of HydePHP v1.7! This latest version brings a host of new features and improvements that enhance the flexibility and user experience of our static site generator. Let's dive into some of the coolest additions and changes in this release.

New Features and Improvements

1. HTML Comments for Markdown Code Block Filepath Labels

One of the standout features in v1.7 is the added support for using HTML comments to create Markdown code block filepath labels. This improvement allows for more descriptive and organized code snippets in your documentation.

2. Customizable Theme Toggle

We've introduced a new config option that allows you to disable the theme toggle buttons. This feature enables your site to automatically use browser settings for theme preferences, providing a more seamless experience for your visitors.

3. Enhanced serve Command

The serve command now allows you to specify which path to open when using the --open option. This addition gives you more control over your development workflow.

4. JSON Output for route:list Command

For those who love working with structured data, we've added a --format=json option to the route:list command. This feature makes it easier to integrate route information into your tooling and scripts.

5. Improved Navigation Group Handling

We've addressed an issue with navigation group behavior. Now, when a navigation group is set in front matter, it will be used regardless of the subdirectory configuration. This change provides more predictable and flexible navigation structuring.

6. Smarter Site URL Handling

Several improvements have been made to how HydePHP handles site URLs:

• The Hyde::hasSiteUrl() method now returns false if the site URL is set to localhost.
• Hyde::url() will return a relative URL instead of throwing an exception when a path is supplied, even if the site URL is not set.
• These changes reduce the chance of default localhost values appearing in production environments.

7. Enhanced Configuration Management

Setting a site name in the YAML config file now influences all configuration values where it's used, unless already set. This change streamlines the process of customizing your site's identity across various components.

Deprecations and Removals

• The global unslash() function has been deprecated in favor of the namespaced \Hyde\unslash() function.
• The BaseUrlNotSetException class has been deprecated.
• The Git version is no longer displayed in the debug screen and dashboard.

Conclusion

HydePHP v1.7 brings a wealth of improvements that enhance developer experience, site customization, and overall flexibility. Whether you're building a personal blog or a complex documentation site, these new features and enhancements will help you create better static sites with less effort.

We encourage all users to upgrade to this latest version to take advantage of these new features and improvements. As always, we welcome your feedback and contributions to make HydePHP even better.

Happy coding with HydePHP v1.7!

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (02393f3) to head (e938921).
Report is 1 commits behind head on master.

Additional details and impacted files

@@             Coverage Diff             @@
##              master     #1779   +/-   ##
===========================================
  Coverage     100.00%   100.00%           
  Complexity      1762      1762           
===========================================
  Files            182       182           
  Lines           4706      4706           
===========================================
  Hits            4706      4706           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.