F# tools for generating documentation (Markdown processor and F# code formatter)
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.paket net461 and netstandard2.0 with working evaluation Oct 14, 2018
FSharp.Formatting.TestHelpers Remove useless project property Oct 15, 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 FSharp.Literate Nuget compilation Oct 14, 2018
packages/FSharp.Formatting Fix doc generation Oct 15, 2018
paket-files/matthid/Yaaf.FSharp.Scripting/src/source/Yaaf.FSharp.Scripting net461 and netstandard2.0 with working evaluation Oct 14, 2018
src CommandTool: replace lineNumbers with noLineNumbers. (#481) Nov 11, 2018
tests Remove useless project property Oct 15, 2018
.editorconfig set newline to lf in editorconfig Apr 17, 2017
.gitattributes Add gitattributes and update version Mar 28, 2013
.gitignore net461 and netstandard2.0 with working evaluation Oct 14, 2018
.travis.yml Use dotnet 2.1.403 Oct 14, 2018
CONTRIBUTING.md Cleanup Apr 8, 2018
Directory.Build.props Fix relative file path for reference assemblies Oct 14, 2018
FSharp.Formatting.sln FSharp.Literate Nuget compilation Oct 14, 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 Fix Literate nuget build Oct 27, 2018
appveyor.yml Remove test result publishing on appveyor Oct 15, 2018
build.fsx Fix Literate nuget build Oct 27, 2018
build.proj update fake to rc_1 Apr 8, 2018
paket.dependencies Try to fix linux build Oct 15, 2018
paket.lock Try to fix linux build Oct 15, 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.