F# tools for generating documentation (Markdown processor and F# code formatter)
F# C# HTML Perl TeX PHP Other
Latest commit d806721 Dec 3, 2017 @matthid matthid Update RELEASE_NOTES.md
Permalink
Failed to load latest commit information.
.paket add magic mode paket.exe (bootstrapper) Apr 17, 2017
FSharp.Formatting.TestHelpers Run paket.install on FSharp.Formatting.TestHelpers Aug 9, 2017
csharp working vs and commandline build Apr 14, 2017
docs Fixed metadata.fsx Jul 10, 2017
lib update FSharp.Core in /lib/ Apr 15, 2017
misc Merge remote-tracking branch 'origin/master' into netcore_support Apr 24, 2017
nuget Include new Razor Component. Jun 16, 2017
packages/FSharp.Formatting Adding FSharp.Compiler.Tools reference to projects Aug 9, 2017
paket-files/matthid/Yaaf.FSharp.Scripting/src/source/Yaaf.FSharp.Scripting do stuff ourself Apr 25, 2017
src Do not override original stack trace. Dec 3, 2017
tests Adding FSharp.Compiler.Tools reference to projects Aug 9, 2017
.editorconfig set newline to lf in editorconfig Apr 17, 2017
.gitattributes Add gitattributes and update version Mar 28, 2013
.gitignore make logging verbose Apr 25, 2017
.travis.yml updates to build May 26, 2017
FSharp.Formatting.sln do stuff ourself Apr 25, 2017
LICENSE.md Adding license file (Apache 2.0) Nov 12, 2012
README.md Move to fsprojects Apr 10, 2017
RELEASE_NOTES.md Update RELEASE_NOTES.md Dec 3, 2017
appveyor.yml update and make stuff work again. May 26, 2017
build.cmd paket magic mode Apr 17, 2017
build.fsx fix System.ValueType. Aug 7, 2017
build.sh paket magic mode Apr 17, 2017
paket.dependencies Adding FSharp.Compiler.Tools reference to projects Aug 9, 2017
paket.lock Adding FSharp.Compiler.Tools reference to projects Aug 9, 2017
start_appveyor trigger appveyor Apr 25, 2017

README.md

F# Formatting Build Status

Join the chat at https://gitter.im/tpetricek/FSharp.Formatting

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#.

Documentation

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.

Who Uses F# Formatting?

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.fsx script in FSharp.ProjectScaffold shows a recommended way for adding F# Formatting docs to your project.

Library license

The library is available under Apache 2.0. For more information see the License file in the GitHub repository.