This is part of the Fake.Documentation.DocFx module.
| Record Field | Description |
BasePath
Signature: string
|
Specify the base path to generate external link, {host}/{locale}/{basePath}.
|
BuildParams
Signature: BuildParams
|
Specify build parameters.
|
CssFilePath
Signature: string
|
Specify the path for the css to generate pdf, default value is styles/default.css.
|
ExcludedTocs
Signature: string list
|
Specify the toc files to be excluded.
|
GeneratesAppendices
Signature: bool option
|
Specify whether or not to generate appendices for not-in-TOC articles.
|
GeneratesExternalLink
Signature: bool option
|
generatesExternalLink", HelpText = "Specify whether or not to generate external links for PDF.
|
Host
Signature: string
|
Specify the hostname to link not-in-TOC articles.
|
KeepRawFiles
Signature: bool option
|
Specify whether or not to keep the intermediate html files that used to generate the PDF file. It it usually used in debug purpose. By default the value is false.
|
LoadErrorHandling
Signature: string
|
Specify how to handle pdf pages that fail to load: abort, ignore or skip(default abort), it is the same input as wkhtmltopdf --load-error-handling options.
|
Locale
Signature: string
|
Specify the locale of the pdf file.
|
Name
Signature: string
|
Specify the name of the generated pdf.
|
RawOutputFolder
Signature: string
|
Specify the output folder for the raw files, if not specified, raw files will by default be saved to _raw subfolder under output folder if keepRawFiles is set to true.
|
| Instance member | Description |
x.WithBuildParams(f)
Signature: (f:(BuildParams -> BuildParams)) -> PdfParams
Modifiers: inline
|
Changes the "BuildParams" according to the given function
|
x.WithCommon(f)
Signature: (f:(CommonParams -> CommonParams)) -> PdfParams
Modifiers: inline
|
Changes the "Common" parameters according to the given function
|
x.WithLogParams(f)
Signature: (f:(LogParams -> LogParams)) -> PdfParams
Modifiers: inline
|
Changes the "LogParams" according to the given function
|
| Static member | Description |
PdfParams.Create()
Signature: unit -> PdfParams
|
Pdf default parameters
|