FSharp.Formatting


Literate

Namespace: FSharp.Literate

This type provides three simple methods for calling the literate programming tool. The ProcessMarkdown and ProcessScriptFile methods process a single Markdown document and F# script, respectively. The ProcessDirectory method handles an entire directory tree (looking for *.fsx and *.md files).

Static members

Static memberDescription
FormatLiterateNodes(...)
Signature: (doc:LiterateDocument * format:OutputKind option * prefix:string option * lineNumbers:bool option * generateAnchors:bool option) -> LiterateDocument
ParseMarkdownFile(...)
Signature: (path:string * formatAgent:CodeFormatAgent option * compilerOptions:string option * definedSymbols:'?234787 option * references:bool option * fsiEvaluator:IFsiEvaluator option) -> LiterateDocument
Type parameters: '?234787

Parse Markdown document

ParseMarkdownString(...)
Signature: (content:string * path:string option * formatAgent:CodeFormatAgent option * compilerOptions:string option * definedSymbols:'?234789 option * references:bool option * fsiEvaluator:IFsiEvaluator option) -> LiterateDocument
Type parameters: '?234789

Parse Markdown document

ParseScriptFile(...)
Signature: (path:string * formatAgent:CodeFormatAgent option * compilerOptions:string option * definedSymbols:'?234783 option * references:bool option * fsiEvaluator:IFsiEvaluator option) -> LiterateDocument
Type parameters: '?234783

Parse F# Script file

ParseScriptString(...)
Signature: (content:string * path:string option * formatAgent:CodeFormatAgent option * compilerOptions:string option * definedSymbols:'?234785 option * references:bool option * fsiEvaluator:IFsiEvaluator option) -> LiterateDocument
Type parameters: '?234785

Parse F# Script file

ProcessDirectory(...)
Signature: (inputDirectory:string * templateFile:string option * outputDirectory:string option * format:OutputKind option * formatAgent:CodeFormatAgent option * prefix:string option * compilerOptions:string option * lineNumbers:bool option * references:bool option * fsiEvaluator:IFsiEvaluator option * replacements:(string * string) list option * includeSource:bool option * layoutRoots:string list option * generateAnchors:bool option * assemblyReferences:string list option * processRecursive:bool option * customizeDocument:(ProcessingContext -> LiterateDocument -> LiterateDocument) option) -> unit

Process directory containing a mix of Markdown documents and F# Script files

ProcessDocument(...)
Signature: (doc:LiterateDocument * output:string * templateFile:string option * format:OutputKind option * prefix:string option * lineNumbers:bool option * includeSource:bool option * generateAnchors:bool option * replacements:(string * string) list option * layoutRoots:string list option * assemblyReferences:string list option) -> unit

Process the given literate document

ProcessMarkdown(...)
Signature: (input:string * templateFile:string option * output:string option * format:OutputKind option * formatAgent:CodeFormatAgent option * prefix:string option * compilerOptions:string option * lineNumbers:bool option * references:bool option * replacements:(string * string) list option * includeSource:bool option * layoutRoots:string list option * generateAnchors:bool option * assemblyReferences:string list option * customizeDocument:(ProcessingContext -> LiterateDocument -> LiterateDocument) option) -> unit

Process Markdown document

ProcessScriptFile(...)
Signature: (input:string * templateFile:string option * output:string option * format:OutputKind option * formatAgent:CodeFormatAgent option * prefix:string option * compilerOptions:string option * lineNumbers:bool option * references:bool option * fsiEvaluator:IFsiEvaluator option * replacements:(string * string) list option * includeSource:bool option * layoutRoots:string list option * generateAnchors:bool option * assemblyReferences:string list option * customizeDocument:(ProcessingContext -> LiterateDocument -> LiterateDocument) option) -> unit

Process F# Script file

WriteHtml(...)
Signature: (doc:LiterateDocument * writer:TextWriter * prefix:string option * lineNumbers:bool option * generateAnchors:bool option) -> unit
WriteHtml(...)
Signature: (doc:LiterateDocument * prefix:string option * lineNumbers:bool option * generateAnchors:bool option) -> string
WriteLatex(...)
Signature: (doc:LiterateDocument * writer:TextWriter * prefix:string option * lineNumbers:bool option * generateAnchors:bool option) -> unit
WriteLatex(...)
Signature: (doc:LiterateDocument * prefix:string option * lineNumbers:bool option * generateAnchors:bool option) -> string
Fork me on GitHub