Settings Class

Summary

Settings used for the conversion
Assembly
Cake.MarkdownToPdf.dll
Namespace
Cake.MarkdownToPdf
Base Types
  • ToolSettings
graph BT Type-->Base0["ToolSettings"] Type["Settings"] class Type type-node

Syntax

public sealed class Settings : ToolSettings

Constructors

Name Summary
Settings() Initialize a new settings instance

Properties

Name Value Summary
CssFile string
Gets or sets the Css file used for rendering the HTML/Pdf
Debug bool
Determines whether to not delete the generated html file
HtmlTemplateFile string
Gets or sets a html template file
MarkdownBaseDirectory string
Gets or sets the base directory used for assets within the markdown having a relative path
MarkdownFile FilePath
Gets or sets the markdown file which should be processed
MarkdownPipeline MarkdownPipelineBuilder
Settings used for parsing markdown
MarkdownText string
Gets or sets the markdown text which should be processed
OutputFile FilePath
Gets or sets the output PDF file
Pdf PdfSettings
Settings for the pdf convert
Theme Themes
Gets or sets the used theme

Methods

Name Value Summary
UseAdvancedMarkdownExtensions() void
Calls the UseAdvancedExtensions() on the MarkdownPipelineBuilder. See https://github.com/lunet-io/markdig/blob/master/src/Markdig/MarkdownExtensions.cs
UseAdvancedMarkdownTables() void
Calls the UsePipeTables() on the MarkdownPipelineBuilder. See https://github.com/lunet-io/markdig/blob/master/src/Markdig/MarkdownExtensions.cs

Extension Methods

Name Value Summary
Dump<Settings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<Settings>(Settings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<Settings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<Settings>(string) void
Requires the Cake.Issues addin
ThrowIfNull<Settings>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<Settings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin
ToStringWithNullMarkup() string
Requires the Cake.Issues addin