F# Formatting: Documentation tools
The F# Formatting libraries (FSharp.CodeFormat.dll and FSharp.Markdown.dll) include
an F# implementation of the Markdown parser and a 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 package also comes with a sample that implements literate programming for F#
(and was used to generate this documentation).
PM> Install-Package FSharp.Formatting
Alternatively, you can download the source as a ZIP file or browse the GitHub repository.
Documentation
The documentation for this library is generated automatically (using the literate programming tools that are built on top of it and are described in literate programming page. If you spot a typo, please submit a pull request! The source Markdown and F# script files are available in the docs folder on GitHub. I hope it is also a good sample showing how to write documentation for F# projects.
Literate programming - if you want to use the library to generate documentation for your projects or if you want to use it to write nicely formatted F# blog posts, then start here! This page describes the literate programming sample.
Markdown parser - this page provides more details about the F# Markdown processor that is available in this library. It includes some basic examples of document processing.
F# code formatting - this page provides more details about the F# code formatter; it discusses how to call it to obtain information about F# source files.
Contributions
The project is hosted on GitHub where you can report issues, fork the project and submit pull requests.
Library license
The library is available under Apache 2.0. For more information see the License file in the GitHub repository.
