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

The following properties are available on the MarkdownBodyPartViewModel class.

The following properties are available on MarkdownBodyPart:

This shape is rendered when a MarkdownField is attached to a content part. The shape base class is of type MarkdownFieldViewModel.

The following properties are available on the MarkdownFieldViewModel class.

The Markdown Part editor can be different for each content type. In the Markdown Part settings of a content type, just select the one that needs to be used.

There are two predefined editor names:

• Default is the editor that is used by default.
• Wysiwyg is the editor that provides a WYSIWYG experience.

Customizing the editor can mean to replace the predefined one with different experiences, or to provide new options for the user to choose from.

To create a new custom editor, it is required to provide two shape templates, one to provide the name of the editor (optional if you want to override an existing one), and a shape to render the actual HTML for the editor.

To declare a new editor, create a shape named Markdown_Option__{Name} where {Name} is a value of your choosing. This will be represented by a file named Markdown-{Name}.Option.cshtml.

Sample content:

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

To define what HTML to render when the editor is selected from the settings, a shape named Markdown_Edit__{Name} corresponding to a file Markdown-{Name}.Edit.cshtml can be created.

Sample content:

@using OrchardCore.Markdown.ViewModels;
@model MarkdownBodyPartViewModel

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

You can override the HTML editor for the Default editor by creating a shape file named Markdown.Edit.cshtml. The WYSIWYG editor is defined by using the file named Markdown-Wysiwyg.Edit.cshtml.

To render a Markdown string to HTML within Razor use the MarkdownToHtmlAsync helper extension method on the view's base Orchard property, e.g.:

@await Orchard.MarkdownToHtmlAsync((string)Model.ContentItem.Content.MarkdownParagraph.Content.Markdown)

In this example we assume that Model.ContentItem.Content.MarkdownParagraph.Content represents an MarkdownField, and Markdown is the field value, and we cast to a string, as extension methods do not support dynamic dispatching.

This helper will also parse any liquid included in the Markdown.

https://github.com/lunet-io/markdig
Copyright (c) 2016, Alexandre Mutel
BSD-2

https://github.com/sparksuite/simplemde-markdown-editor
Copyright (c) 2015 Next Step Webs, Inc.
MIT