MarkdownContentRenderer
Pennington.Markdown
Renders parsed markdown items to HTML using Markdig. After rendering, relative author-written links (e.g. ../how-to/foo.md, sample-post, ./image.png) are rewritten to absolute canonical URLs via MarkdownLinkResolver.
Constructors
MarkdownContentRenderer
#public MarkdownContentRenderer(MarkdownPipeline pipeline = null, MarkdownLinkResolver linkResolver = null, IFileSystem fileSystem = null, ShortcodeExpander shortcodeExpander = null)
Creates the renderer; the default Markdig pipeline is used when none is supplied.
Parameters
pipelineMarkdownPipeline- Markdig pipeline; defaults to
CreateDefault. linkResolverMarkdownLinkResolver- Resolves author-written relative links to canonical URLs.
fileSystemIFileSystem- Backs
[!INCLUDE]expansion; includes are skipped when null. shortcodeExpanderShortcodeExpander- Expands
<?# Name ... ?>shortcodes before Markdig parses; shortcodes are skipped when null.
Methods
RenderAsync
#public Task<ContentItem> RenderAsync(ParsedItem item)
Render a parsed item. Returns RenderedItem on success, FailedItem on failure.
Parameters
itemParsedItem
Returns
Task<ContentItem>Pennington.Markdown.MarkdownContentRenderer
namespace Pennington.Markdown;
/// Renders parsed markdown items to HTML using Markdig. After rendering, relative author-written links (e.g. ../how-to/foo.md, sample-post, ./image.png) are rewritten to absolute canonical URLs via MarkdownLinkResolver.
public class MarkdownContentRenderer
{
/// Creates the renderer; the default Markdig pipeline is used when none is supplied.
public MarkdownContentRenderer(MarkdownPipeline pipeline = null, MarkdownLinkResolver linkResolver = null, IFileSystem fileSystem = null, ShortcodeExpander shortcodeExpander = null)
;
/// Render a parsed item. Returns RenderedItem on success, FailedItem on failure.
public Task<ContentItem> RenderAsync(ParsedItem item)
;
}