FsLiveDocs 0.6.2

FsLiveDocs

FsLiveDocs can be the whole documentation site for an F# library: Markdown guides and generated API reference in one navigation and search index, without Hugo, Docsy, or Docusaurus. One shared shell can host multiple isolated documentation sets with their own routes, sidebars, API surfaces, and verification preludes.

It builds on FSharp.Formatting with richer API pages, API-aware links, source transclusion, checked examples, compiler tooltips, and immutable release documentation.

An ordinary F# fence is compiled against the project it documents:

```fsharp
type Order = { Total: decimal }
let total orders = orders |> List.sumBy _.Total
```

If the API changes, the documentation build fails at the page and line that need fixing. Examples run only when explicitly marked run or transcript.

dotnet new tool-manifest
dotnet tool install FsLiveDocs
dotnet livedocs init --discover-projects
dotnet build
dotnet livedocs audit
dotnet livedocs build
dotnet livedocs watch --host 127.0.0.1 --port 5000

Read the documentation