Processes include statements to include files from the file system.

This module will look for include statements in the content of each document and will replace them with the content of the requested file from the file system. Include statements take the form ^"folder/file.ext". The given path will be converted to a Wyam.Common.IO.FilePath and can be absolute or relative. If relative, it should be relative to the document source. You can escape the include syntax by prefixing the ^ with a forward slash \.

Since Wyam version 2.2.0, you can also use Wyam.Core.Shortcodes.IO.Include shortcode

Usage

Include()

Fluent Methods

Chain these methods together after the constructor to modify behavior.

WithRecursion(bool recursion = true)

Specifies whether the include processing should be recursive. If true (which is the default), then include statements will also be processed in the content of included files recursively.
- recursion
  true if included content should be recursively processed.