markdoccore IPlugin

IPlugin interface

Description

Interface for plugins

Diagram

  flowchart LR
  classDef interfaceStyle stroke-dasharray: 5 5;
  classDef abstractStyle stroke-width:4px
  subgraph MarkDoc.Core
  MarkDoc.Core.IPlugin[[IPlugin]]
  class MarkDoc.Core.IPlugin interfaceStyle;
  end

Loading

Members

Properties

Public properties

Type	Name	Methods
string	Author Plugin author	get
string	Description Plugin description	get
string	Id Plugin id	get
Stream	Image Plugin image	get
string	Name Plugin name	get
IReadOnlyCollection<string>	Steps List of plugin step names	get

Methods

Public methods

Returns	Name
(IMarkDocLogger logger, IReadOnlyCollection processes, Func executor)	GenerateExecutor(IReadOnlyDictionary<string, IReadOnlyDictionary> configuration)
IReadOnlyCollection	GetPluginSteps() Get the IPluginStep instances
T	GetSettings(IReadOnlyDictionary<string, IReadOnlyDictionary> data)

Details

Summary

Interface for plugins

Methods

GetPluginSteps

public abstract IReadOnlyCollection GetPluginSteps()

Summary

Get the IPluginStep instances

Returns

GetSettings

public abstract T GetSettings<T>(IReadOnlyDictionary<string, IReadOnlyDictionary> data)
where T : ILibrarySettings

Arguments

Type	Name	Description
IReadOnlyDictionary<string, IReadOnlyDictionary>	data

GenerateExecutor

public abstract (IMarkDocLogger logger, IReadOnlyCollection processes, Func executor) GenerateExecutor(IReadOnlyDictionary<string, IReadOnlyDictionary> configuration)

Arguments

Type	Name	Description
IReadOnlyDictionary<string, IReadOnlyDictionary>	configuration

Properties

Id

public abstract string Id { get }

Summary

Plugin id

Name

public abstract string Name { get }

Summary

Plugin name

Description

public abstract string Description { get }

Summary

Plugin description

Author

public abstract string Author { get }

Summary

Plugin author

Image

public abstract Stream Image { get }

Summary

Plugin image

Steps

public abstract IReadOnlyCollection Steps { get }

Summary

List of plugin step names

Generated with MarkDoc