MarkdownPdfRunnerSettings Class

Summary

Markdown-pdf settings
Namespace
Cake.Markdown_Pdf
Base Types
  • ToolSettings
graph TD Base0["ToolSettings"]-->Type Type["MarkdownPdfRunnerSettings"] class Type type-node

Syntax

public class MarkdownPdfRunnerSettings : ToolSettings

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