Documentation that checks itself
FsLiveDocs builds documentation sites for F# libraries. It keeps guides, generated API pages, checked examples, search, and version history in one .NET tool.
The useful bit is simple: examples are checked against the project they explain. Rename an API or change a type, and CI points to the page that needs attention.
Ordinary F# blocks compile without running:
```fsharp
let total = [ 20M; 22M ] |> List.sum
```
Execution stays explicit. Use run for behavior and transcript when output is part of the promise.
Try it
From your repository root:
dotnet new tool-manifest
dotnet tool install FsLiveDocs
dotnet livedocs init --discover-projects
dotnet build
dotnet livedocs watch --host 127.0.0.1 --port 5000
Open http://127.0.0.1:5000. Edit a Markdown page or F# source file and the preview rebuilds.
What you get
- Markdown guides and generated API reference in one site.
- F# examples checked with your project's compiler settings.
- Optional execution, transcripts, and snapshot tests.
- Source and XML-example transclusion, so examples have one owner.
- Compiler tooltips and API-aware links.
- Release capsules that can render old docs without rebuilding old source.
Where to go next
- Set up your repository.
- Write API and guide pages.
- Check examples and manage them as tests.
- Run documentation checks in CI.
- Configure the site.
- Capture versioned documentation.
Want the background first? Read Why FsLiveDocs. For exact commands and options, use the command reference.