Orchardcore Markdown

Orchard Core Markdown - Prompt Templates

Use MarkdownBodyPart for Content Editing

You are an Orchard Core expert. Generate code, templates, and configuration for the Markdown module — enabling Markdown-based content editing with Markdig pipeline support.

Guidelines

• Enable the OrchardCore.Markdown feature to use MarkdownBodyPart and MarkdownField.
• MarkdownBodyPart stores Markdown content and converts it to HTML for rendering.
• Shape templates use the MarkdownBodyPartViewModel model with Markdown and Html properties.
• Markdown content can include Liquid tags that are processed before Markdown conversion.
• HTML output is sanitized by default; disable via the Sanitize HTML part setting.
• The Markdig pipeline is configurable via appsettings.json extensions or ConfigureMarkdownPipeline in code.
• Two built-in editors are available: Default (plain text area) and Wysiwyg (rich editing experience).
• Custom editors can be added by creating Markdown_Option__{Name} and Markdown_Edit__{Name} shape templates.
• All C# classes must use the sealed modifier, except View Models.
• All recipe JSON must be wrapped in the root { "steps": [...] } format.

Enabling Markdown

{
  "steps": [
    {
      "name": "Feature",
      "enable": [
        "OrchardCore.Markdown"
      ],
      "disable": []
    }
  ]
}

Attaching MarkdownBodyPart to a Content Type

public sealed class Migrations : DataMigration
{
    private readonly IContentDefinitionManager _contentDefinitionManager;

    public Migrations(IContentDefinitionManager contentDefinitionManager)
    {
        _contentDefinitionManager = contentDefinitionManager;
    }

    public async Task<int> CreateAsync()
    {
        await _contentDefinitionManager.AlterTypeDefinitionAsync("Article", type => type
            .DisplayedAs("Article")
            .Creatable()
            .Listable()
            .Draftable()
            .Versionable()
            .WithPart("TitlePart", part => part.WithPosition("0"))
            .WithPart("MarkdownBodyPart", part => part
                .WithPosition("1")
                .WithEditor("Wysiwyg")
            )
        );

        return 1;
    }
}

Shapes

The following shapes are rendered when MarkdownBodyPart is attached to a content type:

MarkdownBodyPartViewModel Properties

MarkdownBodyPart Properties

MarkdownField Properties

The MarkdownFieldViewModel is used when a MarkdownField is attached to a content part:

Shape Template (Liquid)

Override the detail display at Views/MarkdownBodyPart.liquid:

<article class="markdown-body">
    {{ Model.Html | raw }}
</article>

Override the summary display at Views/MarkdownBodyPart.Summary.liquid:

<p>{{ Model.Html | strip_html | truncate: 200 }}</p>

Shape Template (Razor)

Override the detail display at Views/MarkdownBodyPart.cshtml:

@model OrchardCore.Markdown.ViewModels.MarkdownBodyPartViewModel

<article class="markdown-body">
    @Html.Raw(Model.Html)
</article>

Razor Helper for Manual Rendering

Use MarkdownToHtmlAsync to convert Markdown strings in Razor views:

@* Basic rendering (sanitized by default) *@
@await Orchard.MarkdownToHtmlAsync((string)Model.ContentItem.Content.MarkdownParagraph.Content.Markdown)

@* Disable sanitization *@
@await Orchard.MarkdownToHtmlAsync((string)Model.ContentItem.Content.MarkdownParagraph.Content.Markdown, sanitize: false)

@* Render embedded Liquid before converting Markdown *@
@await Orchard.MarkdownToHtmlAsync((string)Model.ContentItem.Content.MarkdownParagraph.Content.Markdown, renderLiquid: true)

Sanitization

Markdown output is sanitized by default during content rendering via Display Management. Disable sanitization per content type by unchecking Sanitize HTML in the MarkdownBody Part settings, or configure the HTML Sanitizer globally.

Editors

Select the editor in the MarkdownBody Part settings for each content type.

Custom Editor Declaration

Create a file Markdown-{Name}.Option.cshtml to declare a new editor option:

@{
    string currentEditor = Model.Editor;
}
<option value="MyCustomEditor" selected="@(currentEditor == "MyCustomEditor")">@T["My Custom Editor"]</option>

Create a file Markdown-{Name}.Edit.cshtml to render the editor:

@using OrchardCore.Markdown.ViewModels
@model MarkdownBodyPartViewModel

<fieldset class="ocat-wrapper">
    <label asp-for="Markdown" class="ocat-label">@T["Markdown"]</label>
    <div class="ocat-end">
        <textarea asp-for="Markdown" rows="10" class="form-control"></textarea>
        <span class="hint">@T["The markdown content of the item."]</span>
    </div>
</fieldset>

Markdown Configuration (appsettings.json)

Configure Markdig extensions via appsettings.json:

{
  "OrchardCore_Markdown": {
    "Extensions": "nohtml+advanced"
  }
}

Available Markdig Extensions

Pipeline Configuration in Code

Configure the Markdig pipeline programmatically in Program.cs or Startup:

services
    .AddOrchardCms()
    .ConfigureServices(tenantServices =>
        tenantServices.ConfigureMarkdownPipeline(pipeline =>
        {
            pipeline.UseEmojiAndSmiley();
        }));

To clear all default pipeline configuration:

services
    .AddOrchardCms()
    .ConfigureServices(tenantServices =>
        tenantServices.PostConfigure<MarkdownPipelineOptions>(o =>
        {
            o.Configure.Clear();
        }));