IShortcode Interface
Contains the code for a given shortcode.
graph BT Type["IShortcode"] class Type type-node Implementing0["IfShortcode"]-.->Type click Implementing0 "/api/Statiq.Core/IfShortcode" Implementing1["ForEachShortcode"]-.->Type click Implementing1 "/api/Statiq.Core/ForEachShortcode" Implementing2["EmbedShortcode"]-.->Type click Implementing2 "/api/Statiq.Web.Shortcodes/EmbedShortcode" Implementing3["TableShortcode"]-.->Type click Implementing3 "/api/Statiq.Web.Shortcodes/TableShortcode" Implementing4["IncludeShortcode"]-.->Type click Implementing4 "/api/Statiq.Core/IncludeShortcode" Implementing5["GistShortcode"]-.->Type click Implementing5 "/api/Statiq.Web.Shortcodes/GistShortcode" Implementing6["MultiShortcode"]-.->Type click Implementing6 "/api/Statiq.Common/MultiShortcode" Implementing7["GiphyShortcode"]-.->Type click Implementing7 "/api/Statiq.Web.Shortcodes/GiphyShortcode" Implementing8["HighlightShortcode"]-.->Type click Implementing8 "/api/Statiq.Highlight/HighlightShortcode" Implementing9["LinkShortcode"]-.->Type click Implementing9 "/api/Statiq.Web.Shortcodes/LinkShortcode" Implementing10["CodePenShortcode"]-.->Type click Implementing10 "/api/Statiq.Web.Shortcodes/CodePenShortcode" Implementing11["YouTubeShortcode"]-.->Type click Implementing11 "/api/Statiq.Web.Shortcodes/YouTubeShortcode" Implementing12["EvalShortcode"]-.->Type click Implementing12 "/api/Statiq.Core/EvalShortcode" Implementing13["SyncShortcode"]-.->Type click Implementing13 "/api/Statiq.Common/SyncShortcode" Implementing14["SyncMultiShortcode"]-.->Type click Implementing14 "/api/Statiq.Common/SyncMultiShortcode" Implementing15["FigureShortcode"]-.->Type click Implementing15 "/api/Statiq.Web.Shortcodes/FigureShortcode" Implementing16["MarkdownShortcode"]-.->Type click Implementing16 "/api/Statiq.Markdown/MarkdownShortcode" Implementing17["TwitterShortcode"]-.->Type click Implementing17 "/api/Statiq.Web.Shortcodes/TwitterShortcode" Implementing18["RawShortcode"]-.->Type click Implementing18 "/api/Statiq.Core/RawShortcode" Implementing19["Shortcode"]-.->Type click Implementing19 "/api/Statiq.Common/Shortcode" Implementing20["MetaShortcode"]-.->Type click Implementing20 "/api/Statiq.Core/MetaShortcode"

Syntax

public interface IShortcode

Remarks

Shortcode instances are created once-per-document and reused for the life of that document. An exception is that nested shortcodes are always processed by a new instance of the shortcode implementation (which remains in use for that nested content). If a shortcode class also implements IDisposable, the shortcode will be disposed at the processing conclusion.

Methods

Name Return Value Summary
ExecuteAsync(KeyValuePair<string, string>[], string, IDocument, IExecutionContext) Task<IEnumerable<ShortcodeResult>>
Executes the shortcode and returns an IDocument with the shortcode result content and metadata.

Extension Methods