Running the documentation locally

The source of this documentation website is hosted onhttps://github.com/fsharp/fsharp-compiler-docs.
You can follow this guide to see the results of your document changes rendered in the browser.

Setup

fsharp/fsharp-compiler-docs will clone thedotnet/fsharp repository first to generate the documentation.
You can however, easily run the documentation locally and modify thedocs fromdotnet/fsharp.

• Clonefsharp/fsharp-compiler-docs at the same level as your localdotnet/fsharp repository:

gitclonehttps://github.com/fsharp/fsharp-compiler-docs.git

• Restore theFSharp.Compiler.Service project infsharp-compiler-docs:

cdfsharp-compiler-docs/FSharp.Compiler.Servicedotnetrestore

• Restore the local tools infsharp-compiler-docs:

cd..dotnettoolrestore

• Run the documentation tool using yourdotnet/fsharp fork as input.

dotnetfsdocswatch--eval--sourcefolder../fsharp/--input../fsharp/docs/

Release notes caveat

The release notes pages fromdocs/release-notes are composed from the MarkDown files in subfolders.
Changing any of these files, won't regenerate the served webpage. Only the changes to the.fsx will trigger the tool. This is a known limitation.