ArgumentsUnion
PackageFsLiveDocs
Defines the supported command-line arguments for the livedocs tool.
Specification
Kind
Union
Members
54
Examples
0
IsOutputSignature
this.IsOutput
IsDry_RunSignature
this.IsDry_Run
IsUrlSignature
this.IsUrl
IsHistory_AddSignature
this.IsHistory_Add
IsDiscover_ProjectsSignature
this.IsDiscover_Projects
Summary
| Name | Signature | Synopsis |
|---|---|---|
| Union cases | ||
| IsOutput | this.IsOutput | No description available. |
| IsDry_Run | this.IsDry_Run | No description available. |
| IsUrl | this.IsUrl | No description available. |
| IsHistory_Add | this.IsHistory_Add | No description available. |
| IsDiscover_Projects | this.IsDiscover_Projects | No description available. |
| IsCapture | this.IsCapture | No description available. |
| IsSha256 | this.IsSha256 | No description available. |
| IsTheme | this.IsTheme | No description available. |
| IsPort | this.IsPort | No description available. |
| IsVerbosity | this.IsVerbosity | No description available. |
| IsTest | this.IsTest | No description available. |
| IsBanner | this.IsBanner | No description available. |
| IsExtract | this.IsExtract | No description available. |
| IsAudit | this.IsAudit | No description available. |
| IsInit | this.IsInit | No description available. |
| IsInteractive | this.IsInteractive | No description available. |
| IsVersion | this.IsVersion | No description available. |
| IsInspect | this.IsInspect | No description available. |
| IsBuild | this.IsBuild | No description available. |
| IsGenerate_Tests | this.IsGenerate_Tests | No description available. |
| IsWatch | this.IsWatch | No description available. |
| IsCapsule | this.IsCapsule | No description available. |
| IsGenerate_CI | this.IsGenerate_CI | No description available. |
| IsIgnore | this.IsIgnore | No description available. |
| IsHost | this.IsHost | No description available. |
| IsWarn_As_Error | this.IsWarn_As_Error | No description available. |
| IsBuild_History | this.IsBuild_History | 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. |