You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This change was implemented in https://github.com/hydephp/develop/pull/1883. Make sure to update any instances of `FeaturedImage::isRemote()` in your codebase to ensure compatibility with HydePHP v2.0.
503
503
504
+
### Blade-based table of contents generator
505
+
506
+
The way we generate table of contents for documentation pages have been changed from a helper method to a Blade component.
507
+
508
+
See https://github.com/hydephp/develop/pull/2045 for more information.
509
+
510
+
#### Scope
511
+
512
+
The likelihood of impact is low, but if any of the following are true, you may need to update your code:
513
+
514
+
- If you have used the `Hyde\Framework\Actions\GeneratesTableOfContents` class in custom code, you will likely need to update that code for the rewritten class.
515
+
- If you have called the `getTableOfContents` method of the `DocumentationPage` class in custom code, you will need to update that usage as the that message has been removed.
516
+
- If you have published the `resources/views/components/docs/sidebar-item.blade.php` component, you will need to update it to call the new component instead of the old generator rendering.
517
+
518
+
#### Changes
519
+
- Adds a new `resources/views/components/docs/table-of-contents.blade.php` component containing the structure and styles for the table of contents
520
+
- Rewrites the `GeneratesTableOfContents` class to use a custom implementation instead of using CommonMark
521
+
- The `execute` method of the `GeneratesTableOfContents` class now returns an array of data, instead of a string of HTML. This data should be fed into the new component
522
+
- Removed the `table-of-contents.css` file as styles are now made using Tailwind
523
+
504
524
## New features
505
525
506
526
<!-- Editors note: Todo: Maybe move to the relevant docs... -->
0 commit comments