Skip to content

Commit ccd2942

Browse files
committed
Update RELEASE_NOTES.md
1 parent 9ef45dc commit ccd2942

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

RELEASE_NOTES.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -501,6 +501,28 @@ Hyperlinks::isRemote($source);
501501

502502
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.
503503

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+
This new system is much easier to customize and style, and is up to 40 times faster than the old system.
509+
510+
See https://github.com/hydephp/develop/pull/2045 for more information.
511+
512+
#### Scope
513+
514+
The likelihood of impact is low, but if any of the following are true, you may need to update your code:
515+
516+
- 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.
517+
- 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.
518+
- 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.
519+
520+
#### Changes
521+
- Adds a new `resources/views/components/docs/table-of-contents.blade.php` component containing the structure and styles for the table of contents
522+
- Rewrites the `GeneratesTableOfContents` class to use a custom implementation instead of using CommonMark
523+
- 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
524+
- Removed the `table-of-contents.css` file as styles are now made using Tailwind
525+
504526
## New features
505527

506528
<!-- Editors note: Todo: Maybe move to the relevant docs... -->

0 commit comments

Comments
 (0)