The F# Formatting libraries (FSharp.CodeFormat.dll and FSharp.Markdown.dll) include an F# implementation
of a Markdown parser and an F# code formatter that can be used to tokenize F# code and obtain information about tokens
including tool-tips (as in Visual Studio and MonoDevelop) with type information. The library also comes with
a sample that implements literate programming for F#.
The documentation for this library is automatically generated (using the literate programming tools based on
the library) from *.fsx and *.md files in the docs folder. If you find a typo, please submit a pull request!
-
F# Formatting: Documentation tools provides more information about the library, how to contribute, etc. It also includes links to tutorials showing how to use the Markdown parser and F# code formatter.
-
F# Formatting: Literate programming documents the most interesting part of the package - script that can be used to generate documentation for F# projects from commented F# script files and Markdown documents.
The library is used by a number of F# projects. Most prominently, the F# snippets web site uses it to format snippets shared by the F# community. The following sample scripts use the library to generate documentation and might be a useful inspiration:
- The
generate.fsxscript inFSharp.ProjectScaffoldshows a recommended way for adding F# Formatting docs to your project.
The library is available under Apache 2.0. For more information see the License file in the GitHub repository.