This content is part of a third party extension that is not supported by the Cake project.
For more information about this extension see Cake.MarkdownToPdf.
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
|
Markdown |
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 | Markdown |
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
|
PdfSettings |
Settings for the pdf convert
|
|
Theme | Themes |
Gets or sets the used theme
|
Methods
Name | Value | Summary |
---|---|---|
Use |
void |
Calls the UseAdvancedExtensions() on the MarkdownPipelineBuilder.
See https://github.com/lunet-io/markdig/blob/master/src/Markdig/MarkdownExtensions.cs
|
Use |
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 |
string |
Get a basic string representation of specified object.
From LoggingExtensions
Requires the Cake.Incubator addin
|
IsIn |
bool |
Checks if the source is contained in a list
From EnumerableExtensions
Requires the Cake.Incubator addin
|
NotNull |
void |
Throws an exception if the specified parameter's value is null.
From Extensions
Requires the Cake.Ftp addin
|
NotNull |
void |
From IssuesArgumentChecks
Requires the Cake.Issues addin
|
ThrowIfNull |
T |
Throws a
System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator addin
|
ThrowIfNull |
T |
Throws a
System.ArgumentNullException if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator addin
|
ToDictionary |
IDictionary |
From ObjectHelpers
Requires the Cake.DeployParams addin
|
To |
string |
From StringExtensions
Requires the Cake.Issues addin
|