Skip to content

Class FluidMarkdownGenerator

Namespace: Momentum.Extensions.EventMarkdownGenerator.Services
Assembly: Momentum.Extensions.EventMarkdownGenerator.dll

csharp
public class FluidMarkdownGenerator

Inheritance

objectFluidMarkdownGenerator

Inherited Members

object.GetType(), object.MemberwiseClone(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()

Constructors

FluidMarkdownGenerator(string?)

csharp
public FluidMarkdownGenerator(string? customTemplatesDirectory = null)

Parameters

customTemplatesDirectory string?

Methods

CopyDefaultTemplatesToDirectory(string)

csharp
public static void CopyDefaultTemplatesToDirectory(string targetDirectory)

Parameters

targetDirectory string

GenerateAllMarkdown(IEnumerable<EventWithDocumentation>, string, GeneratorOptions?)

csharp
public IEnumerable<IndividualMarkdownOutput> GenerateAllMarkdown(IEnumerable<EventWithDocumentation> events, string outputDirectory, GeneratorOptions? options = null)

Parameters

events IEnumerable<EventWithDocumentation>

outputDirectory string

options GeneratorOptions?

Returns

IEnumerable<IndividualMarkdownOutput>

GenerateAllSchemas(IEnumerable<Type>, string)

csharp
public IEnumerable<IndividualMarkdownOutput> GenerateAllSchemas(IEnumerable<Type> schemaTypes, string outputDirectory)

Parameters

schemaTypes IEnumerable<Type>

outputDirectory string

Returns

IEnumerable<IndividualMarkdownOutput>

GenerateMarkdown(EventWithDocumentation, string, GeneratorOptions?)

csharp
public IndividualMarkdownOutput GenerateMarkdown(EventWithDocumentation eventWithDoc, string outputDirectory, GeneratorOptions? options = null)

Parameters

eventWithDoc EventWithDocumentation

outputDirectory string

options GeneratorOptions?

Returns

IndividualMarkdownOutput

GenerateSchemaMarkdown(Type, string)

csharp
public IndividualMarkdownOutput GenerateSchemaMarkdown(Type schemaType, string outputDirectory)

Parameters

schemaType Type

outputDirectory string

Returns

IndividualMarkdownOutput