FAKE - F# Make - A DSL for build tasks and more FAKE
6.1.3

Lookig for older versions of the documentation, pre FAKE v6? See 

v5.fake.build

Fsdocs Module

Namespace: Fake.DotNet
Assembly: Fake.DotNet.Fsdocs.dll

Contains tasks to interact with fsdocs tool to process F# script files, markdown and for generating API documentation.

Types

Type Description

BuildCommandParams

Fsdocs build command parameters and options

WatchCommandParams

Fsdocs watch command parameters and options

Functions and values

Function or value Description

Fsdocs.build setBuildParams

Full Usage: Fsdocs.build setBuildParams

Parameters:

Build documentation using fsdocs build command

setBuildParams : BuildCommandParams -> BuildCommandParams

Function used to overwrite the build command default parameters.

Example 


 Fsdocs.build (fun p -> { p with Clean = Some(true); Strict = Some(true) })

Fsdocs.watch setWatchParams

Full Usage: Fsdocs.watch setWatchParams

Parameters:

Watch documentation using fsdocs watch command

setWatchParams : WatchCommandParams -> WatchCommandParams

Function used to overwrite the watch command default parameters.

Example 


 Fsdocs.watch (fun p -> { p with Port = Some(3005) })