@anglr/md-help - npm Package Versions

Version 8.0.0 (2022-02-17)

Features

• new RenderMarkdownConfig interface as config for render markdown function
  • property codeRenderers code renderer configuration
    • new CodeRenderersConfig interface as code renderers configuration
  • property charMap char map used for normalization of ids and anchor fragments
  • property baseUrl base url used for routing links
  • property assetsPathPrefix path for static assets
• new DEFAULT_RENDER_MARKDOWN_CONFIG default configuration for RenderMarkdownConfig
• new RENDER_MARKDOWN_CONFIG as injection token used for injecting render markdown config
• new CodeRenderer interface as code renderer that handles rendering block of code
• new HighlightJsCodeRenderer function as code renderer using highlight js
• new updateRenderMarkdownConfig function that updates render markdown config with custom values
• new MD_HELP_NOTIFICATIONS injection token used for injecting notifications service used in this md help package
• new RenderMarkdownPipe pipe that converts markdown string into html
• added subpackage @anglr/md-help/mermaid
• subpackage @anglr/md-help/mermaid
  • new MermaidCodeRenderer function as code renderer using mermaid

BREAKING CHANGES

• minimal supported version of Angular is 12.0.0
• minimal supported version of @jscrpt/common is 1.2.0
• minimal supported version of marked is 2.0.0
• minimal supported version of highlight.js is 10.6.0
• minimal supported version of mermaid is 8.9.2
• no longer depends on @anglr/notifications instead uses @anglr/common version 9.0.0
• RenderMarkdownDirective constructor has new optional parameter
• RenderMarkdownIncludeDirective constructor has new optional parameter
• BaseHelpComponent constructor has new optional parameter
• renderMarkdown function has new signature, added new parameter with configuration and moved some parameters into it
• GlobalNotificationsService replaced with Notifications from @anglr/common package, using MD_HELP_NOTIFICATIONS InjectionToken

Version 7.0.1

• added RenderMarkdownIncludeDirective supporting import of another markdowns (one level)
• fixed handleRouterLink, now checks anchors only with href attribute
• RenderMarkdownIncludeDirective now handles hash routes in markdown
• BaseHelpComponent has no default baseUrl now
• renderMarkdown does not automatically prefix links with /
• added hljs css class to <code> when rendering code
• handleRouterLink now supports also redirecting to absolute URL with same origin and performs scrollIntoView
• added getCurrentUrlPrefix which computes origin
• renderMarkdown now correctly normalize ids and anchor fragments
• @jscrpt/common@1.1.1 is required