F# tools for generating documentation (Markdown processor and F# code formatter)
Clone or download
matthid Merge pull request #473 from fsprojects/fix_472
proper formatting of the usage
Latest commit bc6fd45 Jul 29, 2018
Permalink
Failed to load latest commit information.
.paket Updates paket files (in magic mode). Feb 24, 2018
FSharp.Formatting.TestHelpers add fsharp.compiler.service to be compatible with latest fake 5 release Apr 8, 2018
csharp working vs and commandline build Apr 14, 2017
docs Merge branch 'master' of github.com:fsprojects/FSharp.Formatting into… Apr 8, 2018
lib update FSharp.Core in /lib/ Apr 15, 2017
misc Adds support for attributes on modules, types and members May 6, 2018
nuget Include new Razor Component. Jun 16, 2017
packages/FSharp.Formatting add fsharp.compiler.service to be compatible with latest fake 5 release Apr 8, 2018
paket-files/matthid/Yaaf.FSharp.Scripting/src/source/Yaaf.FSharp.Scripting update FSharp.Compiler.Service Dec 17, 2017
src proper formatting of the usage, fixes #472 Jul 29, 2018
tests proper formatting of the usage, fixes #472 Jul 29, 2018
.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 Cleanup Apr 8, 2018
CONTRIBUTING.md Cleanup Apr 8, 2018
FSharp.Formatting.sln Adds support for attributes on modules, types and members May 6, 2018
LICENSE.md Adding license file (Apache 2.0) Nov 12, 2012
README.md Merge pull request #454 from marcpiechura/patch-1 Feb 4, 2018
RELEASE_NOTES.md proper formatting of the usage, fixes #472 Jul 29, 2018
appveyor.yml build nuget on appveyor Apr 8, 2018
build.fsx Use our own getpackageversion code. Apr 8, 2018
build.proj update fake to rc_1 Apr 8, 2018
paket.dependencies add fsharp.compiler.service to be compatible with latest fake 5 release Apr 8, 2018
paket.lock add fsharp.compiler.service to be compatible with latest fake 5 release Apr 8, 2018
start_appveyor trigger appveyor Apr 25, 2017

README.md

F# Formatting Build Status

Join the chat at https://gitter.im/fsprojects/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.