FSharp.Formatting.CommandTool 7.1.0

Suggested Alternatives

fsdocs-tool

Additional Details

fsharp.formatting.commandtool has been renamed to fsdocs-tool, see https://github.com/fsprojects/FSharp.Formatting/issues/720

There is a newer version of this package available.
See the version list below for details.
dotnet tool install --global FSharp.Formatting.CommandTool --version 7.1.0
                    
This package contains a .NET tool you can call from the shell/command line.
dotnet new tool-manifest
                    
if you are setting up this repo
dotnet tool install --local FSharp.Formatting.CommandTool --version 7.1.0
                    
This package contains a .NET tool you can call from the shell/command line.
#tool dotnet:?package=FSharp.Formatting.CommandTool&version=7.1.0
                    
nuke :add-package FSharp.Formatting.CommandTool --version 7.1.0
                    

The package is a collection of libraries that can be used for literate programming
     with F# (great for building documentation) and for generating library documentation
     from inline code comments. The key componments are Markdown parser, tools for formatting
     F# code snippets, including tool tip type information and a tool for generating
     documentation from library metadata.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
.NET Core netcoreapp3.1 is compatible. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

- add text content of markdown and scripts to generated search index
- overhaul the substitution names used by FSharp.Formatting and expected in the template. The table is in the docs and below
- generate {{fsdocs-list-of-documents}} substitution and use it in both API docs and content
- generate {{fsdocs-list-of-namespaces}} substitution and use it in both API docs and content
- fix link model so {{root}} is always respected
- Add `qualify` parameter that asks to qualify all names by the collection name e.g. FSharp.Core
- Respect per-project settings, e.g. if one nuget package has a different set of authors or home page to another
- Add documentation about styling
- Allow fixed-left and fixed-right positions for the navbar
- Add `{{fsdocs-logo-link}}` parameter to default template
- Add `{{fsdocs-logo-link}}` parameter to default template
- generate HTML giving hyperlinks for types with cross-links
- switch to left bootstrap nav bar in template for a table of contents
- improve sizings
- move to one copy of template in docs/_template.html
- ApiDocsTypeDefinition and ApiDocsModule merged to ApiDocsEntity
- Default template now expects logo in img/logo.png
- Improvements in default HTML generation
- ApiDocComment.Blurb renamed to ApiDocComment.Summary and only populated with summary text for things read from XML
- simplify tool instructions
- add info about upgrading