FSharp.Formatting is a set of libraries and tools for processing F# script files, markdown and for generating API documentation. F# Formatting package is used by this project and many other repositories.
To use the tool, install and use the fsdocs tool in a typical F# project with
F# project files plus markdown and script content in the
dotnet tool install FSharp.Formatting.CommandTool dotnet fsdocs build dotnet fsdocs watch
To use the tool, explore the following topics:
Authoring Content - explains the content expected in the
docs directory for the
Using the Command line tool - explains how to use the
Generating API documentation - how to generate HTML documentation from "XML comments" in your .NET libraries. The tool handles comments written in Markdown too.
Styling - explains some options for styling the output of
Using literate programming - explains how to generate documentation for your projects or to write nicely formatted F# blog posts.
Embedding F# outputs in literate programming - provides more details on literate programming and explains how to embed results of a literate script file in the generated output. This way, you can easily format the results of running your code!
F# Formatting is also available on NuGet as a set of libraries.
Markdown parser - explains the F# Markdown processor that is available in this library with some basic examples of document processing.
F# code formatting - more details about the F# code formatter and how to use it to obtain information about F# source files.
The documentation for this library is generated automatically using the tools built here. 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.