MarkdownPdfRunnerSettingsExtensions Class

Summary

Extensions to apply settings to MarkdownPdfRunnerSettings
Assembly
Cake.Markdown-Pdf.dll
Namespace
Cake.Markdown_Pdf
Base Types
  • Object
graph BT Type-->Base0["Object"] Type["MarkdownPdfRunnerSettingsExtensions"] class Type type-node

Syntax

public static class MarkdownPdfRunnerSettingsExtensions

Methods

Name Value Summary
UseWorkingDirectory(MarkdownPdfRunnerSettings, DirectoryPath) MarkdownPdfRunnerSettings
Set the working directory context from where the markdown-pdf command will run
static
WithCssPath(MarkdownPdfRunnerSettings, string) MarkdownPdfRunnerSettings
Path to custom CSS file
static
WithFilePath(MarkdownPdfRunnerSettings, string) MarkdownPdfRunnerSettings
Path of the markdown file to convert
static
WithHelp(MarkdownPdfRunnerSettings) MarkdownPdfRunnerSettings
output usage information
static
WithHighlightCssPath(MarkdownPdfRunnerSettings, string) MarkdownPdfRunnerSettings
Path to custom highlight-CSS file
static
WithLoadTimeout(MarkdownPdfRunnerSettings, int) MarkdownPdfRunnerSettings
Timeout before the page is rendered in case `page.onLoadFinished` isn't fired
static
WithOrientation(MarkdownPdfRunnerSettings, MarkdownPdfOrientation) MarkdownPdfRunnerSettings
'portrait' or 'landscape'
static
WithOutFilePath(MarkdownPdfRunnerSettings, string) MarkdownPdfRunnerSettings
Path of where to save the PDF
static
WithPaperBorder(MarkdownPdfRunnerSettings, string) MarkdownPdfRunnerSettings
Supported dimension units are: 'mm', 'cm', 'in', 'px'
static
WithPaperFormat(MarkdownPdfRunnerSettings, MarkdownPdfPaperFormat) MarkdownPdfRunnerSettings
'A3', 'A4', 'A5', 'Legal', 'Letter' or 'Tabloid'
static
WithPhantomPath(MarkdownPdfRunnerSettings, string) MarkdownPdfRunnerSettings
Path to phantom binary
static
WithRemarkableOptions(MarkdownPdfRunnerSettings, string) MarkdownPdfRunnerSettings
Options to pass to Remarkable
static
WithRenderDelay(MarkdownPdfRunnerSettings, int) MarkdownPdfRunnerSettings
Delay before rendering the PDF
static
WithRunningsPath(MarkdownPdfRunnerSettings, string) MarkdownPdfRunnerSettings
Path to runnings (header, footer)
static
WithVersion(MarkdownPdfRunnerSettings) MarkdownPdfRunnerSettings
output the version number
static

Extension Methods

Name Value Summary
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin
ToStringWithNullMarkup() string
Requires the Cake.Issues addin