ServeParams (Fake)

DocFx.ServeParams Type

Namespace: Fake.Documentation
Assembly: Fake.Documentation.DocFx.dll
Parent Module: DocFx
Base Type: obj
All Interfaces: IEquatable<ServeParams> , IStructuralEquatable , IComparable<ServeParams> , IComparable , IStructuralComparable

Serve-Command parameters

Record Field	Description
`Common` Full Usage: `Common` Field type: `CommonParams`	Specify common docFx options Field type: `CommonParams`
`Folder` Full Usage: `Folder` Field type: `string`	folder path Field type: `string`
`Host` Full Usage: `Host` Field type: `string`	Specify the hostname of the hosted website [localhost]. Field type: `string`
`Port` Full Usage: `Port` Field type: `int option`	Specify the port of the hosted website [8080] Field type: `int option`

Instance member Description

Instance member	Description
`this.WithCommon` Full Usage: `this.WithCommon` Parameters: f : `CommonParams -> CommonParams` Returns: `ServeParams` Modifiers: inline	Changes the "Common" parameters according to the given function f : `CommonParams -> CommonParams` Returns: `ServeParams`


                
                  
                    
                      this.WithCommon

Full Usage: this.WithCommon

Parameters:

f : CommonParams -> CommonParams

Returns: ServeParams
Modifiers: inline

Changes the "Common" parameters according to the given function

Static member	Description
`ServeParams.Create()` Full Usage: `ServeParams.Create()` Returns: `ServeParams`	Serve default parameters Returns: `ServeParams`