Convert Gherkin to HTML with Pickles

INFO

This documentation is for FAKE version 5.0 or later. The old documentation can be found here

Pickles is a Living Documentation generator: it takes your Specification (written in Gherkin, with Markdown descriptions) and turns them into an always up-to-date documentation of the current state of your software - in a variety of formats.

API-Reference

Minimal working example

 1: 
 2: 
 3: 
 4: 
 5: 
 6: 
 7: 
 8: 
 9: 
10: 
11: 
12: 
13: 
14: 
15: 
16: 
17: 
18: 
19: 
20: 
21: 
22: 

#r "paket:
nuget Fake.Core.Target
nuget Fake.IO.FileSystem
nuget Fake.Tools.Pickles
//"

open Fake.Core
open Fake.IO.FileSystemOperators
open Fake.IO.Globbing
open Fake.Tools
open System.IO

let currentDirectory = Directory.GetCurrentDirectory()

Target.create "BuildDoc" (fun _ ->
    Pickles.convert (fun p ->
        { p with FeatureDirectory = currentDirectory </> "Specs"
                 OutputDirectory = currentDirectory </> "SpecDocs"
                 OutputFileFormat = Pickles.DocumentationFormat.DHTML })
)

Target.runOrDefault "BuildDoc"
namespace System
namespace System.IO
val currentDirectory : string
type Directory =
  static member CreateDirectory : path:string -> DirectoryInfo
  static member Delete : path:string -> unit + 1 overload
  static member EnumerateDirectories : path:string -> IEnumerable<string> + 3 overloads
  static member EnumerateFileSystemEntries : path:string -> IEnumerable<string> + 3 overloads
  static member EnumerateFiles : path:string -> IEnumerable<string> + 3 overloads
  static member Exists : path:string -> bool
  static member GetCreationTime : path:string -> DateTime
  static member GetCreationTimeUtc : path:string -> DateTime
  static member GetCurrentDirectory : unit -> string
  static member GetDirectories : path:string -> string[] + 3 overloads
  ...
Directory.GetCurrentDirectory() : string