Contains the code for a given shortcode.
- Namespace
- Statiq
.Common - Implementing Types
-
- TableShortcode
- YouTubeShortcode
- SyncMultiShortcode
- GiphyShortcode
- HighlightShortcode
- SyncShortcode
- Shortcode
- FigureShortcode
- IncludeShortcode
- CodePenShortcode
- MetaShortcode
- MarkdownShortcode
- EmbedShortcode
- MultiShortcode
- EvalShortcode
- LinkShortcode
- TwitterShortcode
- RawShortcode
- ForEachShortcode
- GistShortcode
- IfShortcode
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 |
Task |
Executes the shortcode and returns an
IDocument with the shortcode result content and metadata.
|