Skip to content

Releases: hydephp/develop

v1.7.0 - 2024-07-05

05 Jul 13:08
50b5ce7
Compare
Choose a tag to compare

1.7.0 - 2024-07-05

Added

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

Changed

  • When a navigation group is set in front matter, it will now be used regardless of the subdirectory configuration in #1703 (fixes #1515)
  • Use late static bindings to support overriding data collections file finding in #1717 (fixes #1716)
  • Method Hyde::hasSiteUrl() now returns false if the site URL is for localhost in #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 #1726
  • Updated the .env.example file to contain more details on the site URL setting's usages in #1746
  • Added a version prefix to the sitemap's generator attribute in #1767
  • Setting a site name in the Yaml config file will now influence all configuration values where this is used, unless already set, in #1770 and #1773

Deprecated

  • Deprecated the global unslash() function, replaced with the existing namespaced \Hyde\unslash() function in #1753
  • Deprecated the BaseUrlNotSetException class in #1759

Removed

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

Fixed

  • Fixed explicitly set front matter navigation group behavior being dependent on subdirectory configuration, fixing #1515 in #1703
  • Fixed DataCollections file finding method not being able to be overridden #1716 in #1717
  • Fixed PHP warning when trying to parse a Markdown file with just front matter without body #1705 in #1728
  • Fixed #1748 by normalizing generator version prefixes in #1767
  • Yaml data files no longer need to start with triple dashes to be parsed by DataCollections in #1733
  • Updated the Hyde URL helper to not modify already qualified URLs in #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.

What's Changed in the Monorepo

What's Changed

Read more

v1.6.0 - 2024-04-17

17 Apr 12:57
39a7e5a
Compare
Choose a tag to compare

1.6.0 - 2024-04-17

Added

  • Added a @head stack to the head.blade.php component in #1567
  • Added a Hyde::route() helper to the Hyde facade in #1591
  • Added new global helper functions (asset(), route(), url()) in #1592
  • Added a new Feature enum to improve the Features facade in #1650
  • Added a helper to ->skip() build tasks in #1656

Changed

  • The features array in the config/hyde.php configuration file is now an array of Feature enums in #1650
  • Sitemap generation will now be skipped if a base URL is not set, as Google now will not index sitemaps without a base URL in #1660
  • Updated the debug command to print the binary path when running in a standalone Phar in #1667

Deprecated

  • Deprecated the static Features flag methods used in the configuration files in #1650 which will be removed in HydePHP v2.0

Fixed

  • Fixed a bug where the sitemap and RSS feed generator commands did not work when the _site/ directory was not present in #1654
  • Fixed extra newlines being written to console for failing build tasks in #1661
  • Markdown formatting will now be stripped when generating an automatic blog post description when none is set in #1662 (fixes #1634)
  • Realtime Compiler: Fixed responsive dashboard table issue in #1595

Upgrade Path

In order to prepare your project for HydePHP v2.0, you should update your config/hyde.php configuration file to use the new Feature enum for the features array.

You can see the changes to make in your Hyde project by looking at the following pull request https://github.com/hydephp/hyde/pull/250/files

Your new config array should look like this:

    // Make sure to import the new Feature enum at the top of the file 
    use Hyde\Enums\Feature;
    
    // Then replace your enabled features with the new Feature enum cases
    'features' => [
        // Page Modules
        Feature::HtmlPages,
        Feature::MarkdownPosts,
        Feature::BladePages,
        Feature::MarkdownPages,
        Feature::DocumentationPages,

        // Frontend Features
        Feature::Darkmode,
        Feature::DocumentationSearch,

        // Integrations
        Feature::Torchlight,
    ],

If you need more help, you can see detailed upgrade instructions with screenshots in the pull request #1650

What's Changed in the Monorepo

What's Changed

Full Changelog: v1.5.0...v1.6.0

v1.5.0 - 2024-02-13

13 Feb 11:04
53d6aea
Compare
Choose a tag to compare

1.5.0 - 2024-02-13

Improved Patch Release Strategy

This release experiments some changes into how releases are handled to clarify the patch versioning of distributed packages compared to the monorepo source versioning.

In short: We are now experimenting with rolling patch releases, where patches are released as soon as they're ready, leading to faster rollout of bugfixes.
This means that the patch version discrepancy between the monorepo and the distributed packages will be increased, but hopefully the end results will still be clearer,
thanks to the second related change: Prefixing the subpackage changes in this changelog with the package name. If there is no prefix, the change applies to the core package or the monorepo.

All this to say, please keep in mind that when the monorepo gets a new minor version, the prefixed changes may already have been released as patches in their respective packages.

Added

  • Added the existing media_extensions option to the hyde configuration file in #1531
  • Added configuration options to add custom HTML to the <head> and <script> sections in #1542
  • Added support for adding custom HTML to the <head> and <script> sections using HTML includes in #1554
  • Added an html helper to the Includes facade in #1552

Changed

  • Renamed local template variable $document to $article to better match the usage in #1506
  • Updated semantic documentation article component to support existing variables in #1506
  • Updated the Markdown to plain text converter to trim whitespace in #1561
  • HydeFront: Changed <code> styling to display as inline instead of inline-block in #1525
  • Realtime Compiler: Add strict type declarations in #1555
  • Bumped Realtime Compiler version to v3.3 in #1562
  • Internal: Renamed snake case test methods to camel case in #1556

Deprecated

  • Deprecated the BuildService::transferMediaAssets() method in #1533, as it will be moved into a build task in v2.0.

Fixed

What's Changed in the Monorepo

Full Changelog: v1.4.0...v1.5.0

v1.4.0 - 2023-12-11

11 Dec 09:57
b882bf2
Compare
Choose a tag to compare

1.4.0 - 2023-12-11

Added

  • Adds a new fancy output for the realtime compiler serve command in #1444
  • Added support for dot notation in the Yaml configuration files in #1478
  • Added a config option to customize automatic sidebar navigation group names in #1481
  • Added a new hyde serve --open option to automatically open the site in the browser in #1483
  • Added a new Live Edit feature to the realtime compiler in #1458

Changed

  • The docs.sidebar.footer config option now accepts a Markdown string to replace the default footer in #1477
  • Links in the sitemap.xml file are now relative when a site URL is not set, instead of using the default localhost URL in #1479
  • Improves the portability of the realtime compiler to better support running through the standalone executable in #1488
  • Bumps realtime compiler version to v3.2 in #1489
  • Support both route keys and identifiers for specifying sidebar order in #1432
  • Updated sitemap generator to use relative links instead of localhost when missing site URL in #1479

Removed

  • Removed unhelpful boilerplate from the hyde/hyde package.json in #1436

Fixed

  • Fixed dot notation in Yaml configuration not being expanded (#1471) in #1478

Internal

  • Internal: Only inject custom app config location when missing from parent in #1485
  • Internal: Remove experimental Phar support from internal configuration loader in #1485

What's Changed in the Monorepo

Full Changelog: v1.3.0...v1.4.0

v1.3.0 - 2023-10-30

30 Oct 17:45
0ed0f15
Compare
Choose a tag to compare

1.3.0 - 2023-10-30

Added

  • Added support for setting custom content when calling source file creator actions directly in #1393
  • Added support for setting a custom post date when calling post file creator action directly in #1393
  • Added optional FileNotFoundException constructor parameter to set a custom exception message #1398
  • Added a new helper method to the base Command class to ask for a string input from the user in #1416
  • The realtime compiler dashboard is now interactive, and allows you to make edits to your project right from the browser #1392

Changed

  • Realtime Compiler: The DashboardController class is now marked as internal, as it is not intended to be used outside of the package #1394
  • Updated the realtime compiler server configuration options in #1395 (backwards compatible)
  • Updated the realtime compiler to generate the documentation search index each time it's requested in #1405 (fixes #1404)
  • Updated the navigation menu generator to remove duplicates after running the sorting method in #1407 (fixes #1406)
  • Updated the exception message caused by missing source option for featured images to include the path of the file that caused the error in #1409
  • Narrows down parsed BladeMatter array types to array<string, scalar> (Experimental feature not covered by BC promise) in #1410
  • Internal code refactors and improvements in #1410, #1411, and #1413

Fixed

  • Catch RealtimeCompiler dashboard OutOfBoundsException in #1384
  • Updated dropdown navigation menus to support setting priority in config in #1387 (fixing hydephp/hyde#229)
  • Updated the vendor publish command to support parent Laravel Prompts implementation in #1388
  • Fixed wrong version constant in #1391
  • Fixed improperly formatted exception message in #1399
  • Fixed missing support for missing and out of date search indexes when previewing site #1404 in #1405
  • Fixed duplicate navigation items not giving precedence to config defined items #1406 in #1407

What's Changed in the Monorepo

Full Changelog: v1.2.0...v1.3.0

v1.2.0 - 2023-06-22

22 Jun 15:07
da31d15
Compare
Choose a tag to compare

Added

  • Added Markdown configuration option for the Tailwind prose classes in #1357
  • Added prose-img:inline to bundled TailwindCSS classes in #1359

Changed

  • Internal: Decoupled the monorepo composer.json settings in #1361
  • Changed HydePage return types to static in #1371

Removed

  • Removed the Tailwind safelist from the hyde/hyde package (as it is not required there) in #1362

Fixed

  • Fixed two improper method type annotations in the FrontMatter class in #1369

What's Changed in the Monorepo

Read more

v1.1.0 - 2023-03-22

22 Mar 11:39
e2cdb6b
Compare
Choose a tag to compare

About

This release is the first since the official release of HydePHP 1.0.0. It contains a number of bug fixes and improvements, but no breaking changes as the project has reached general availability and adheres to the semantic versioning backwards compatibility promise.

What's Changed

Full Changelog: v1.0.0...v1.1.0

v1.0.0-RC.8 - 2023-03-14

14 Mar 17:43
f3f3ee3
Compare
Choose a tag to compare

What's Changed

Full Changelog: v1.0.0-RC.7...v1.0.0-RC.8

v1.0.0-RC.7 - 2023-03-14

14 Mar 12:25
8b7ace7
Compare
Choose a tag to compare

What's Changed

Full Changelog: v1.0.0-RC.6...v1.0.0-RC.7

v1.0.0-RC.6 - 2023-03-14

14 Mar 10:25
6a8f4d2
Compare
Choose a tag to compare

What's Changed

Full Changelog: v1.0.0-RC.5...v1.0.0-RC.6