Skip to content

v17.0.0

Compare
Choose a tag to compare
@jfcere jfcere released this 11 Nov 03:31
· 42 commits to master since this release

Update Angular 17

Library has been updated to support Angular 17.

It is recommended to stick with ngx-markdown v16.x.x if you are using Angular 16.

New features and enhancements

  • Update to Angular 17
  • Update marked lib to ^9.0.0
  • Add support for marked extensions
  • Update mermaid.js optional dependency to ^10.6.0
  • Update emoji-toolkit optional dependency to ^8.0.0 which supports unicode 15.0

⚠️ Breaking changes

  • All options that were removed from marked has been deleted from this library too, see more at https://marked.js.org/using_advanced#options
  • The srcRelativeLink input property is removed as the baseUrl option has been removed from marked, use https://www.npmjs.com/package/marked-base-url instead
  • MarkdownService.parse() method now returns Promise<string> instead of string, because marked parsing is doing so
  • MarkdownPipe now returns Promise<string> instead of string and will need to be combined with async pipe to work correctly
  • Both markedOptions and clipboardOptions configuration properties used in the MarkdownModule.forRoot(config: MarkdownModuleConfig) method now require to be provided with the MARKED_OPTIONS and CLIPBOARD_OPTIONS injection token.
  • The @types/marked dependency is no longer needed and needs to be removed

Additional information

  • Including marked.min.js file in the scripts section of the angular.json when using @angular\cli is no longer needed and can safely be removed as it is automatically imported.

Special thanks

🥇 Thanks to @json-derulo for his contribution to update Angular 17.
🥇 Thanks to @robertIsaac for his contribution to update marked library and adding support for extensions.
🥇 Thanks to @sarfudheen for his contribution to update mermaid.js library.

Commits