Yaml Class

Summary

Parses YAML content for each input document and stores the result in it's metadata.
Assembly
Wyam.Yaml.dll
Namespace
Wyam.Yaml
Interfaces
Base Types
  • Object
graph BT Type-->Base0["Object"] Type-.->Interface0["IModule"] click Interface0 "/api/Wyam.Common.Modules/IModule" Type["Yaml"] class Type type-node

Syntax

public class Yaml : IModule

Remarks

Parses the content for each input document and then stores a dynamic object representing the first YAML document in metadata with the specified key. If no key is specified, then the dynamic object is not added. You can also flatten the YAML to add top-level pairs directly to the document metadata.

Constructors

Name Summary
Yaml() The content of the input document is parsed as YAML. All root-level scalars are added to the input document's metadata. Any more complex YAML structures are ignored. This is best for simple key-value YAML documents.
Yaml(string, bool) The content of the input document is parsed as YAML. A dynamic object representing the first YAML document is set as the value for the given metadata key. See YamlDotNet.Dynamic for more details about the dynamic YAML object. If flatten is true, all root-level scalars are also added to the input document's metadata.

Methods

Name Value Summary
Execute(IReadOnlyList<IDocument>, IExecutionContext) IEnumerable<IDocument>
This should not be called directly, instead call IExecutionContext.Execute() if you need to execute a module from within another module.
GitHub