Summary
Includes a file from the virtual file system.
- Assembly
- Wyam
.Core .dll - Namespace
- Wyam
.Core .Shortcodes .IO - Interfaces
- Base Types
-
- Object
graph BT
Type-->Base0["Object"]
Type-.->Interface0["IShortcode"]
click Interface0 "/api/Wyam.Common.Shortcodes/IShortcode"
Type["Include"]
class Type type-node
Syntax
public class Include : IShortcodeExamples
Example usage to show the contents of test-include.html in the output
<?# Include "test-include.html" /?>If the included file contains Markdown syntax, you can even include it before the Markdown engine runs with a slight syntax change:
<?! Include "test-include.md" /?>?Remarks
The raw content of the file will be rendered where the shortcode appears.
If the file does not exist nothing will be rendered.
Methods
| Name | Value | Summary |
|---|---|---|
| Execute |
IShortcodeResult |
Executes the shortcode and returns an
Wyam.Common.Shortcodes.IShortcodeResult.
|