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.Markdown-Pdf.

Summary

Markdown-pdf settings

Assembly

Cake.Markdown-Pdf.dll

Namespace

Cake.Markdown_Pdf

Base Types

ToolSettings

graph BT Type-->Base0["ToolSettings"] Type["MarkdownPdfRunnerSettings"] class Type type-node

Syntax

public class MarkdownPdfRunnerSettings : ToolSettings

Constructors

Name	Summary
MarkdownPdfRunnerSettings()

Properties

Name	Value	Summary
CssPath	string	Path to custom CSS file
FilePath	string	Path of the markdown file to convert
Help	bool	output usage information
HighlightCssPath	string	Path to custom highlight-CSS file
LoadTimeout	int	Timeout before the page is rendered in case `page.onLoadFinished` isn't fired
Orientation	MarkdownPdfOrientation	'portrait' or 'landscape'
OutFilePath	string	Path of where to save the PDF
PaperBorder	string	Supported dimension units are: 'mm', 'cm', 'in', 'px'
PaperFormat	MarkdownPdfPaperFormat	'A3', 'A4', 'A5', 'Legal', 'Letter' or 'Tabloid'
PhantomPath	string	Path to phantom binary
RemarkableOptions	string	Options to pass to Remarkable
RenderDelay	int	Delay before rendering the PDF
RunningsPath	string	Path to runnings (header, footer)
Version	bool	output the version number

Extension Methods

Name	Value	Summary
Dump<MarkdownPdfRunnerSettings>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<MarkdownPdfRunnerSettings>(MarkdownPdfRunnerSettings[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<MarkdownPdfRunnerSettings>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
NotNull<MarkdownPdfRunnerSettings>(string)	void	From IssuesArgumentChecks Requires the Cake.Issues addin
ThrowIfNull<MarkdownPdfRunnerSettings>(string, string)	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<MarkdownPdfRunnerSettings>(string)	T	Throws a `System.ArgumentNullException` if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ToDictionary()	IDictionary<string, object>	From ObjectHelpers Requires the Cake.DeployParams addin
ToStringWithNullMarkup()	string	From StringExtensions Requires the Cake.Issues addin
UseWorkingDirectory(DirectoryPath)	MarkdownPdfRunnerSettings	Set the working directory context from where the markdown-pdf command will run From MarkdownPdfRunnerSettingsExtensions Requires the Cake.Markdown-Pdf addin
WithCssPath(string)	MarkdownPdfRunnerSettings	Path to custom CSS file From MarkdownPdfRunnerSettingsExtensions Requires the Cake.Markdown-Pdf addin
WithFilePath(string)	MarkdownPdfRunnerSettings	Path of the markdown file to convert From MarkdownPdfRunnerSettingsExtensions Requires the Cake.Markdown-Pdf addin
WithHelp()	MarkdownPdfRunnerSettings	output usage information From MarkdownPdfRunnerSettingsExtensions Requires the Cake.Markdown-Pdf addin
WithHighlightCssPath(string)	MarkdownPdfRunnerSettings	Path to custom highlight-CSS file From MarkdownPdfRunnerSettingsExtensions Requires the Cake.Markdown-Pdf addin
WithLoadTimeout(int)	MarkdownPdfRunnerSettings	Timeout before the page is rendered in case `page.onLoadFinished` isn't fired From MarkdownPdfRunnerSettingsExtensions Requires the Cake.Markdown-Pdf addin
WithOrientation(MarkdownPdfOrientation)	MarkdownPdfRunnerSettings	'portrait' or 'landscape' From MarkdownPdfRunnerSettingsExtensions Requires the Cake.Markdown-Pdf addin
WithOutFilePath(string)	MarkdownPdfRunnerSettings	Path of where to save the PDF From MarkdownPdfRunnerSettingsExtensions Requires the Cake.Markdown-Pdf addin
WithPaperBorder(string)	MarkdownPdfRunnerSettings	Supported dimension units are: 'mm', 'cm', 'in', 'px' From MarkdownPdfRunnerSettingsExtensions Requires the Cake.Markdown-Pdf addin
WithPaperFormat(MarkdownPdfPaperFormat)	MarkdownPdfRunnerSettings	'A3', 'A4', 'A5', 'Legal', 'Letter' or 'Tabloid' From MarkdownPdfRunnerSettingsExtensions Requires the Cake.Markdown-Pdf addin
WithPhantomPath(string)	MarkdownPdfRunnerSettings	Path to phantom binary From MarkdownPdfRunnerSettingsExtensions Requires the Cake.Markdown-Pdf addin
WithRemarkableOptions(string)	MarkdownPdfRunnerSettings	Options to pass to Remarkable From MarkdownPdfRunnerSettingsExtensions Requires the Cake.Markdown-Pdf addin
WithRenderDelay(int)	MarkdownPdfRunnerSettings	Delay before rendering the PDF From MarkdownPdfRunnerSettingsExtensions Requires the Cake.Markdown-Pdf addin
WithRunningsPath(string)	MarkdownPdfRunnerSettings	Path to runnings (header, footer) From MarkdownPdfRunnerSettingsExtensions Requires the Cake.Markdown-Pdf addin
WithVersion()	MarkdownPdfRunnerSettings	output the version number From MarkdownPdfRunnerSettingsExtensions Requires the Cake.Markdown-Pdf addin

MarkdownPdfRunnerSettings Class

Summary

Syntax

Constructors

Properties

Extension Methods