feature: extend Umbraco.MarkdownEditor

Author: jcdcdev

src/jcdcdev.Umbraco.ExtendedMarkdownEditor/Composing/Composer.cs

@@ -8,5 +8,6 @@ public class Composer : IComposer
     public void Compose(IUmbracoBuilder builder)
     {
         builder.ManifestFilters().Append<ManifestFilter>();
+        builder.AddMarkDown();
     }
 }

src/jcdcdev.Umbraco.ExtendedMarkdownEditor/Composing/UmbracoBuilderExtensions.cs

@@ -0,0 +1,19 @@
+using jcdcdev.Umbraco.ExtendedMarkdownEditor.PropertyEditors;
+using jcdcdev.Umbraco.ExtendedMarkdownEditor.Services;
+using Microsoft.Extensions.DependencyInjection;
+using Umbraco.Cms.Core.DependencyInjection;
+using Umbraco.Cms.Core.PropertyEditors;
+using Umbraco.Cms.Core.PropertyEditors.ValueConverters;
+
+namespace jcdcdev.Umbraco.ExtendedMarkdownEditor.Composing;
+
+public static class UmbracoBuilderExtensions
+{
+    public static IUmbracoBuilder AddMarkDown(this IUmbracoBuilder builder)
+    {
+        builder.Services.AddSingleton<IMarkdownService, MarkdownService>();
+        builder.PropertyValueConverters().Replace<MarkdownEditorValueConverter, ExtendedMarkdownEditorValueConverter>();
+        builder.DataEditors().Exclude<MarkdownPropertyEditor>();
+        return builder;
+    }
+}

src/jcdcdev.Umbraco.ExtendedMarkdownEditor/Extensions/MarkdownExtensions.cs

@@ -0,0 +1,22 @@
+using System.Diagnostics.CodeAnalysis;
+using Markdig;
+using Markdig.Syntax;
+
+namespace jcdcdev.Umbraco.ExtendedMarkdownEditor.Extensions;
+
+internal static class MarkdownExtensions
+{
+    public static bool TryParse(string markdown, [NotNullWhen(true)] out MarkdownDocument? document)
+    {
+        try
+        {
+            document = Markdown.Parse(markdown);
+            return true;
+        }
+        catch
+        {
+            document = null;
+            return false;
+        }
+    }
+}

src/jcdcdev.Umbraco.ExtendedMarkdownEditor/Models/MarkdownConvertorOptions.cs

@@ -0,0 +1,8 @@
+namespace jcdcdev.Umbraco.ExtendedMarkdownEditor.Models;
+
+public class MarkdownConvertorOptions
+{
+    public int? HeaderOffset { get; init; }
+    public bool ExternalLinksOpenInNewTab { get; init; }
+    public bool TransformLinks => ExternalLinksOpenInNewTab;
+}

src/jcdcdev.Umbraco.ExtendedMarkdownEditor/Models/MarkdownValue.cs

@@ -0,0 +1,28 @@
+using System.Diagnostics.CodeAnalysis;
+using Markdig.Syntax;
+using Umbraco.Cms.Core.Strings;
+
+namespace jcdcdev.Umbraco.ExtendedMarkdownEditor.Models;
+
+public class MarkdownValue
+{
+    private MarkdownValue(string raw, MarkdownDocument? markdown, IHtmlEncodedString html)
+    {
+        Raw = raw;
+        Html = html;
+        Markdown = markdown;
+    }
+
+    private MarkdownValue()
+    {
+    }
+
+    [MemberNotNullWhen(true, nameof(Markdown), nameof(Html), nameof(Raw))]
+    public bool IsValid => Markdown != null && Html != null && !string.IsNullOrWhiteSpace(Raw);
+
+    public MarkdownDocument? Markdown { get; }
+    public string? Raw { get; }
+    public IHtmlEncodedString? Html { get; }
+    public static MarkdownValue Empty => new();
+    public static MarkdownValue Create(string raw, MarkdownDocument markdown, IHtmlEncodedString html) => new(raw, markdown, html);
+}

src/jcdcdev.Umbraco.ExtendedMarkdownEditor/PropertyEditors/ExtendedMarkdownConfiguration.cs

@@ -0,0 +1,12 @@
+using Umbraco.Cms.Core.PropertyEditors;
+
+namespace jcdcdev.Umbraco.ExtendedMarkdownEditor.PropertyEditors;
+
+public class ExtendedMarkdownConfiguration : MarkdownConfiguration
+{
+    [ConfigurationField("headerOffset", "Header Offset", "number", Description = "The offset to apply to any header tags")]
+    public int? HeaderOffset { get; set; }
+
+    [ConfigurationField("externalLinksOpenInNewTab", "External Links Open In New Tab", "boolean", Description = "Ensures external links open in a new tab")]
+    public bool ExternalLinksOpenInNewTab { get; set; }
+}

src/jcdcdev.Umbraco.ExtendedMarkdownEditor/PropertyEditors/ExtendedMarkdownConfigurationEditor.cs

@@ -0,0 +1,13 @@
+using Umbraco.Cms.Core.IO;
+using Umbraco.Cms.Core.PropertyEditors;
+using Umbraco.Cms.Core.Services;
+
+namespace jcdcdev.Umbraco.ExtendedMarkdownEditor.PropertyEditors;
+
+// Or should it be: ExtendedMarkdownConfigurationConfigurationEditor? :D
+internal class ExtendedMarkdownConfigurationEditor : ConfigurationEditor<ExtendedMarkdownConfiguration>
+{
+    public ExtendedMarkdownConfigurationEditor(IIOHelper ioHelper, IEditorConfigurationParser editorConfigurationParser) : base(ioHelper, editorConfigurationParser)
+    {
+    }
+}

src/jcdcdev.Umbraco.ExtendedMarkdownEditor/PropertyEditors/ExtendedMarkdownEditorValueConverter.cs

@@ -0,0 +1,40 @@
+using jcdcdev.Umbraco.ExtendedMarkdownEditor.Models;
+using jcdcdev.Umbraco.ExtendedMarkdownEditor.Services;
+using Umbraco.Cms.Core.Models.PublishedContent;
+using Umbraco.Cms.Core.PropertyEditors;
+using Umbraco.Cms.Core.PropertyEditors.ValueConverters;
+using Umbraco.Cms.Core.Templates;
+
+namespace jcdcdev.Umbraco.ExtendedMarkdownEditor.PropertyEditors;
+
+public class ExtendedMarkdownEditorValueConverter : MarkdownEditorValueConverter
+{
+    private readonly IMarkdownService _markdownService;
+
+    public ExtendedMarkdownEditorValueConverter(
+        HtmlLocalLinkParser localLinkParser,
+        HtmlUrlParser urlParser,
+        IMarkdownService markdownService) : base(localLinkParser, urlParser)
+    {
+        _markdownService = markdownService;
+    }
+
+    public override Type GetPropertyValueType(IPublishedPropertyType propertyType) => typeof(MarkdownValue);
+
+    public override object ConvertIntermediateToObject(IPublishedElement owner, IPublishedPropertyType propertyType, PropertyCacheLevel referenceCacheLevel, object? inter, bool preview)
+    {
+        if (inter is not string s)
+        {
+            return MarkdownValue.Empty;
+        }
+
+        var config = propertyType.DataType.ConfigurationAs<ExtendedMarkdownConfiguration>();
+        var options = new MarkdownConvertorOptions
+        {
+            HeaderOffset = config?.HeaderOffset,
+            ExternalLinksOpenInNewTab = config?.ExternalLinksOpenInNewTab ?? false
+        };
+
+        return _markdownService.CreateFromMarkdownString(s, options);
+    }
+}

src/jcdcdev.Umbraco.ExtendedMarkdownEditor/PropertyEditors/ExtendedMarkdownPropertyEditor.cs

@@ -0,0 +1,44 @@
+using Microsoft.Extensions.DependencyInjection;
+using Umbraco.Cms.Core;
+using Umbraco.Cms.Core.IO;
+using Umbraco.Cms.Core.PropertyEditors;
+using Umbraco.Cms.Core.Services;
+using Umbraco.Cms.Web.Common.DependencyInjection;
+
+namespace jcdcdev.Umbraco.ExtendedMarkdownEditor.PropertyEditors;
+
+[DataEditor(
+    Constants.PropertyEditors.Aliases.MarkdownEditor,
+    "Markdown editor",
+    "markdowneditor",
+    ValueType = ValueTypes.Text,
+    Group = Constants.PropertyEditors.Groups.RichContent,
+    Icon = "icon-code",
+    ValueEditorIsReusable = true)]
+public class ExtendedMarkdownPropertyEditor : MarkdownPropertyEditor
+{
+    private readonly IEditorConfigurationParser _editorConfigurationParser;
+
+    private readonly IIOHelper _ioHelper;
+
+    [Obsolete("Please use constructor that takes an IEditorConfigurationParser instead")]
+    public ExtendedMarkdownPropertyEditor(IDataValueEditorFactory dataValueEditorFactory, IIOHelper ioHelper) : base(dataValueEditorFactory, ioHelper)
+    {
+        _ioHelper = ioHelper;
+        _editorConfigurationParser = StaticServiceProvider.Instance.GetRequiredService<IEditorConfigurationParser>();
+    }
+
+    public ExtendedMarkdownPropertyEditor(IDataValueEditorFactory dataValueEditorFactory, IIOHelper ioHelper, IEditorConfigurationParser editorConfigurationParser) : base(dataValueEditorFactory,
+        ioHelper,
+        editorConfigurationParser)
+    {
+        _ioHelper = ioHelper;
+        _editorConfigurationParser = editorConfigurationParser;
+    }
+
+    protected override IConfigurationEditor CreateConfigurationEditor()
+    {
+        var config = new ExtendedMarkdownConfigurationEditor(_ioHelper, _editorConfigurationParser);
+        return config;
+    }
+}

src/jcdcdev.Umbraco.ExtendedMarkdownEditor/Services/IMarkdownService.cs

@@ -0,0 +1,8 @@
+using jcdcdev.Umbraco.ExtendedMarkdownEditor.Models;
+
+namespace jcdcdev.Umbraco.ExtendedMarkdownEditor.Services;
+
+public interface IMarkdownService
+{
+    MarkdownValue CreateFromMarkdownString(string markdown, MarkdownConvertorOptions? config = null);
+}