ArgumentsUnion

PackageFsLiveDocs

Defines the supported command-line arguments for the livedocs tool.

Specification

Kind

Union

Members

Examples

IsBuildSignature

this.IsBuild

IsBuild_HistorySignature

this.IsBuild_History

IsWatchSignature

this.IsWatch

IsDiscover_ProjectsSignature

this.IsDiscover_Projects

IsWarn_As_ErrorSignature

this.IsWarn_As_Error

Summary

Name	Signature	Synopsis
IsBuild	this.IsBuild	No description available.
IsBuild_History	this.IsBuild_History	No description available.
IsWatch	this.IsWatch	No description available.
IsDiscover_Projects	this.IsDiscover_Projects	No description available.
IsWarn_As_Error	this.IsWarn_As_Error	No description available.
IsTest	this.IsTest	No description available.
IsInteractive	this.IsInteractive	No description available.
IsGenerate_CI	this.IsGenerate_CI	No description available.
IsVersion	this.IsVersion	No description available.
IsSha256	this.IsSha256	No description available.
IsCapsule	this.IsCapsule	No description available.
IsUrl	this.IsUrl	No description available.
IsIgnore	this.IsIgnore	No description available.
IsPort	this.IsPort	No description available.
IsTheme	this.IsTheme	No description available.
IsHistory_Add	this.IsHistory_Add	No description available.
IsDry_Run	this.IsDry_Run	No description available.
IsVerbosity	this.IsVerbosity	No description available.
IsInspect	this.IsInspect	No description available.
IsGenerate_Tests	this.IsGenerate_Tests	No description available.
IsInit	this.IsInit	No description available.
IsCapture	this.IsCapture	No description available.
IsHost	this.IsHost	No description available.
IsOutput	this.IsOutput	No description available.
IsAudit	this.IsAudit	No description available.
IsExtract	this.IsExtract	No description available.
IsBanner	this.IsBanner	No description available.
Init	Init	Adds FsLiveDocs configuration and starter documentation to a repository.
Generate_CI	Generate_CI	Generates a GitHub Actions workflow for documentation verification and releases.
Generate_Tests	Generate_Tests projectPaths	Generates a test project for documentation examples.
Extract	Extract projectPaths	Extracts symbol metadata from projects into JSON snapshots.
Capture	Capture projectPaths	Captures a self-contained, renderer-neutral documentation release.
Inspect	Inspect capsulePath	Verifies and describes a release capsule.
History_Add	History_Add version	Adds an immutable capsule reference to a release history index.
Test	Test projectPaths	Runs verified code examples found in docstrings.
Audit	Audit projectPaths	Audits coverage and compiler-checks every expanded F# documentation block.
Build	Build projectPaths	Builds the full static documentation site.
Build_History	Build_History manifestPath	Builds every version in a verified local history manifest.
Watch	Watch projectPaths	Builds, serves, and rebuilds a local documentation preview.
Theme	Theme string	Sets the generated site's visual theme.
Version	Version string	Sets the documentation version for build, extraction, or capture.
Output	Output string	Sets the output path for commands that write an artifact or history index.
Capsule	Capsule string	Sets a local capsule path for history-add.
Url	Url string	Sets an HTTPS capsule URL for history-add.
Sha256	Sha256 string	Sets the expected capsule SHA-256 for history-add.
Host	Host string	Sets the network interface used by the preview server.
Port	Port int	Sets the TCP port used by the preview server.
Ignore	Ignore string	Adds directory names the preview watcher must not watch or rebuild for.
Warn_As_Error	Warn_As_Error	Fails the run when the documented API produces quality warnings.
Verbosity	Verbosity string	Sets console verbosity to warnings, info, or debug.
Interactive	Interactive bool	Enables or disables interactive terminal rendering.
Banner	Banner bool	Enables or disables the LiveDocs banner.
Discover_Projects	Discover_Projects	Discovers documentable projects and records them in .livedocs/config.json during init.
Dry_Run	Dry_Run	Validates capture and reports its expected result without writing a capsule.

IsBuild

this.IsBuild

Member

Returns

bool

IsBuild_History

this.IsBuild_History

Member

Returns

bool

IsWatch

this.IsWatch

Member

Returns

bool

IsDiscover_Projects

this.IsDiscover_Projects

Member

Returns

bool

IsWarn_As_Error

this.IsWarn_As_Error

Member

Returns

bool

IsTest

this.IsTest

Member

Returns

bool

IsInteractive

this.IsInteractive

Member

Returns

bool

IsGenerate_CI

this.IsGenerate_CI

Member

Returns

bool

IsVersion

this.IsVersion

Member

Returns

bool

IsSha256

this.IsSha256

Member

Returns

bool

IsCapsule

this.IsCapsule

Member

Returns

bool

IsUrl

this.IsUrl

Member

Returns

bool

IsIgnore

this.IsIgnore

Member

Returns

bool

IsPort

this.IsPort

Member

Returns

bool

IsTheme

this.IsTheme

Member

Returns

bool

IsHistory_Add

this.IsHistory_Add

Member

Returns

bool

IsDry_Run

this.IsDry_Run

Member

Returns

bool

IsVerbosity

this.IsVerbosity

Member

Returns

bool

IsInspect

this.IsInspect

Member

Returns

bool

IsGenerate_Tests

this.IsGenerate_Tests

Member

Returns

bool

IsInit

this.IsInit

Member

Returns

bool

IsCapture

this.IsCapture

Member

Returns

bool

IsHost

this.IsHost

Member

Returns

bool

IsOutput

this.IsOutput

Member

Returns

bool

IsAudit

this.IsAudit

Member

Returns

bool

IsExtract

this.IsExtract

Member

Returns

bool

IsBanner

this.IsBanner

Member

Returns

bool

Init

Member

Adds FsLiveDocs configuration and starter documentation to a repository.

Returns

unit

Generate_CI

Member

Generates a GitHub Actions workflow for documentation verification and releases.

Returns

unit

Generate_Tests

Generate_Tests projectPaths

Member

Generates a test project for documentation examples.

Parameters

Name	Type	Description
projectPaths	string list

Returns

unit

Extract

Extract projectPaths

Member

Extracts symbol metadata from projects into JSON snapshots.

Parameters

Name	Type	Description
projectPaths	string list

Returns

unit

Capture

Capture projectPaths

Member

Captures a self-contained, renderer-neutral documentation release.

Parameters

Name	Type	Description
projectPaths	string list

Returns

unit

Inspect

Inspect capsulePath

Member

Verifies and describes a release capsule.

Parameters

Name	Type	Description
capsulePath	string

Returns

unit

History_Add

History_Add version

Member

Adds an immutable capsule reference to a release history index.

Parameters

Name	Type	Description
version	string

Returns

unit

Test

Test projectPaths

Member

Runs verified code examples found in docstrings.

Parameters

Name	Type	Description
projectPaths	string list

Returns

unit

Audit

Audit projectPaths

Member

Audits coverage and compiler-checks every expanded F# documentation block.

Parameters

Name	Type	Description
projectPaths	string list

Returns

unit

Build

Build projectPaths

Member

Builds the full static documentation site.

Parameters

Name	Type	Description
projectPaths	string list

Returns

unit

Build_History

Build_History manifestPath

Member

Builds every version in a verified local history manifest.

Parameters

Name	Type	Description
manifestPath	string

Returns

unit

Watch

Watch projectPaths

Member

Builds, serves, and rebuilds a local documentation preview.

Parameters

Name	Type	Description
projectPaths	string list

Returns

unit

Theme

Theme string

Member

Sets the generated site's visual theme.

Parameters

Name	Type	Description
Item	string

Returns

unit

Version

Version string

Member

Sets the documentation version for build, extraction, or capture.

Parameters

Name	Type	Description
Item	string

Returns

unit

Output

Output string

Member

Sets the output path for commands that write an artifact or history index.

Parameters

Name	Type	Description
Item	string

Returns

unit

Capsule

Capsule string

Member

Sets a local capsule path for history-add.

Parameters

Name	Type	Description
Item	string

Returns

unit

Url

Url string

Member

Sets an HTTPS capsule URL for history-add.

Parameters

Name	Type	Description
Item	string

Returns

unit

Sha256

Sha256 string

Member

Sets the expected capsule SHA-256 for history-add.

Parameters

Name	Type	Description
Item	string

Returns

unit

Host

Host string

Member

Sets the network interface used by the preview server.

Parameters

Name	Type	Description
Item	string

Returns

unit

Port

Port int

Member

Sets the TCP port used by the preview server.

Parameters

Name	Type	Description
Item	int

Returns

unit

Ignore

Ignore string

Member

Adds directory names the preview watcher must not watch or rebuild for.

Parameters

Name	Type	Description
Item	string

Returns

unit

Warn_As_Error

Member

Fails the run when the documented API produces quality warnings.

Returns

unit

Verbosity

Verbosity string

Member

Sets console verbosity to warnings, info, or debug.

Parameters

Name	Type	Description
Item	string

Returns

unit

Interactive

Interactive bool

Member

Enables or disables interactive terminal rendering.

Parameters

Name	Type	Description
Item	bool

Returns

unit

Banner

Banner bool

Member

Enables or disables the LiveDocs banner.

Parameters

Name	Type	Description
Item	bool

Returns

unit

Discover_Projects

Member

Discovers documentable projects and records them in .livedocs/config.json during init.

Returns

unit

Dry_Run

Member

Validates capture and reports its expected result without writing a capsule.

Returns

unit