Deprecate hey-red/Markdown #19500

[gavinfaux]

• Replace with xoofx/markdig
• Update package version in Directory.Packages.props
• Update license entry in NOTICES.txt
• Update package reference in src\Umbraco.Infrastructure\Umbraco.Infrastructure.csproj
• Update src\Umbraco.Core\Composing\TypeFinder.cs
• Update src\Umbraco.Infrastructure\HealthChecks\MarkdownToHtmlConverter.cs
• Update src\Umbraco.Infrastructure\PropertyEditors\ValueConverters\MarkdownEditorValueConverter.cs

Prerequisites

• [ x ] I have added steps to test this contribution in the description below

If there's an existing issue for this PR then this fixes #19500

Description

• Ran all Markdown Unit Tests - ✅
• Ran all the tests - ✅

[github-actions]

Hi there @gavinfaux, thank you for this contribution! 👍

While we wait for one of the Core Collaborators team to have a look at your work, we wanted to let you know about that we have a checklist for some of the things we will consider during review:

• It's clear what problem this is solving, there's a connected issue or a description of what the changes do and how to test them
• The automated tests all pass (see "Checks" tab on this PR)
• The level of security for this contribution is the same or improved
• The level of performance for this contribution is the same or improved
• Avoids creating breaking changes; note that behavioral changes might also be perceived as breaking
• If this is a new feature, Umbraco HQ provided guidance on the implementation beforehand
• 💡 The contribution looks original and the contributor is presumably allowed to share it

Don't worry if you got something wrong. We like to think of a pull request as the start of a conversation, we're happy to provide guidance on improving your contribution.

If you realize that you might want to make some changes then you can do that by adding new commits to the branch you created for this work and pushing new commits. They should then automatically show up as updates to this pull request.

Thanks, from your friendly Umbraco GitHub bot 🤖 🙂

[gavinfaux]

Perhaps this should be an extension or helper to enable use in other places / packages, just as Articulate uses?

using Markdig;

namespace Umbraco.Extensions;
{
    public static class MarkdownExtensions
    {
        private static readonly MarkdownPipeline s_markdownPipeline = new MarkdownPipelineBuilder()
            .UseAdvancedExtensions()
            .Build();

        public static string ToHtml(string input) => Markdown.ToHtml(input, s_markdownPipeline);
    }
}

[AndyButland]

Thanks for this @gavinfaux - it's a good catch, and I agree we should update this to the supported library. I'd suggest the following things to consider if you are up for some modifications:

• As this is a breaking change and 16 is very close, I think the earliest we can introduce this change would be 17, so please could you re-target to v17/dev?
• I'm not sure about the extension method suggestion, some people frown on polluting the generic string too much (in the sense that the proposed method will be visible on all strings, not the small fraction of them that contain markdown).
• Rather maybe we should make better use of the existing IMarkdownToHtmlConverter? Developers could inject and use that if they needed this service. But that should have some small changes:
  • It currently lives in a namespace that indicates it's only used for health checks. Likely the interface and implementation should be moved to the namespace Umbraco.Cms.Core.Strings Umbraco.Cms.Infrastructure.Strings respectively (and the files moved on disk to the corresponding folders).
  • It currently has some code specific for handling the strings found in health check results. I feel they should be removed and put in EmailNotificationMethod directly.
  • We should ourselves inject and use this in MarkdownEditorValueConverter rather than referencing the Markdown library directly.

[gavinfaux]

Aha! IMarkdownToHtmlConverter makes much more sense, I was focused on the where rather than the how.

Will close PR and target against v17/dev. Thanks for the guidance.

[LennardF1989]

This line: private static readonly MarkdownPipeline _markdownPipeline = new MarkdownPipelineBuilder().UseAdvancedExtensions().Build(); is now in 4 locations. Agree with Andy that it should only be done in the MarkdownToHtmlConverter, and then all other places should inject IMarkdownToHtmlConverter instead.

That would make enabling additional (custom) extensions rather easy.

Any reason you are enabling the AdvancedExtensions by default, though?

[AndyButland]

I've picked this up again in #21242.

[gavinfaux]

Thank you. I did look at this but was unsure of on a couple of points/breaking changes, perhaps documentation updates suffice and end users can override defaults via DI/Composition if needed.

• Existing content and line breaks (“breaks” in marked):

  • marked breaks is false by default; to match rendering single newlines as <br>
    • UseSoftlineBreakAsHardlineBreak() in Markdig if wanting to preserve behaviour.

• Markdig pipeline defaults and optional plugins

  • By default, without any options, Markdig is using the plain CommonMark parser
  • Should default pipeline allow HTML or not DisableHtml()
  • Is there a case for enabling additional plugins for Health Check emails or other defaults, e.g.
    • Autolinks → UseAutoLinks()
    • Pipe tables → UsePipeTables(new PipeTableOptions { UseHeaderForColumnCount = true })
    • Task lists → UseTaskLists()

I should have raised/asked this a while ago, apologies!