Markdown (OrchardCore.Markdown)Link



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

Name Display Type Default Location Model Type
MarkdownPart Detail Content:5 MarkdownPartViewModel
MarkdownPart Summary Content:10 MarkdownPartViewModel


The following properties are available on the MarkdownPartViewModel class.

Property Type Description
Markdown string The Markdown value once all tokens have been processed
Html string The HTML content resulting from the Mardkown source
ContentItem ContentItem The content item of the part
MarkdownPart MarkdownPart The MarkdownPart instance
TypePartSettings MarkdownPartSettings The settings of the part


The following properties are available on MarkdownPart

Name Type Description
Markdown The Markdown content. It can contain Liquid tags so using it directly might result in unexpected results. Prefer rendering the MarkdownPart shape instead
Content The raw content of the part
ContentItem The content item containing this part


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

The following properties are available on the MarkdownFieldViewModel class.

Property Type Description
Markdown string The Markdown value once all tokens have been processed
Html string The HTML content resulting from the Mardkown source
Field MarkdownField The MarkdownField instance
Part ContentPart The part this field attached to
PartFieldDefinition ContentPartFieldDefinition The part field definition


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

Custom EditorsLink

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 and 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>

HTML EditorLink

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

Sample content:

@using OrchardCore.Markdown.ViewModels;
@model MarkdownPartViewModel

<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>

Overriding the predefined editorsLink

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


Copyright (c) 2016, Alexandre Mutel

SimpleMDELink Copyright (c) 2015 Next Step Webs, Inc.