en-US/Hyde-help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Clear-StaticSite</command:name> <command:verb>Clear</command:verb> <command:noun>StaticSite</command:noun> <maml:description> <maml:para>Removes generated Hyde output and cache artifacts.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Clear-StaticSite removes generated content for a Hyde site, including the destination folder and common build artifact paths used by Hyde/Jekyll-compatible workflows.</maml:para> <maml:para>The command initializes a normal Hyde build context so destination resolution follows the same rules as build commands (site config, source location, and optional override).</maml:para> <maml:para>Safety checks prevent destructive cleanup scenarios such as deleting drive roots, site source roots, or parent paths of the source tree.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Clear-StaticSite</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>SourcePath</maml:name> <maml:description> <maml:para>Optional site source path used to resolve the site configuration and configured destination. When omitted, Hyde uses its default source discovery behavior.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Destination</maml:name> <maml:description> <maml:para>Optional destination override. When provided, it takes precedence over destination values from site configuration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>ScriptPath</maml:name> <maml:description> <maml:para>Internal/back-compat parameter for wrapper invocation. Not intended for normal use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>ModuleRoot</maml:name> <maml:description> <maml:para>Internal override for Hyde module root resolution. Not intended for normal use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>Version</maml:name> <maml:description> <maml:para>Internal override for reported Hyde version. Not intended for normal use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Quiet</maml:name> <maml:description> <maml:para>Suppresses informational output and emits only warnings/errors unless verbose output is enabled.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>SourcePath</maml:name> <maml:description> <maml:para>Optional site source path used to resolve the site configuration and configured destination. When omitted, Hyde uses its default source discovery behavior.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Destination</maml:name> <maml:description> <maml:para>Optional destination override. When provided, it takes precedence over destination values from site configuration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Quiet</maml:name> <maml:description> <maml:para>Suppresses informational output and emits only warnings/errors unless verbose output is enabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>ScriptPath</maml:name> <maml:description> <maml:para>Internal/back-compat parameter for wrapper invocation. Not intended for normal use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>ModuleRoot</maml:name> <maml:description> <maml:para>Internal override for Hyde module root resolution. Not intended for normal use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>Version</maml:name> <maml:description> <maml:para>Internal override for reported Hyde version. Not intended for normal use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert /> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Clear-StaticSite -SourcePath .\site</dev:code> <dev:remarks> <maml:para>Resolves site config from .\site and removes generated output and cache targets.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Clear-StaticSite -SourcePath .\site -Destination .\site\_dist</dev:code> <dev:remarks> <maml:para>Uses .\site for config lookup but removes generated output from the explicit destination override.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>Clear-StaticSite -SourcePath .\site -WhatIf</dev:code> <dev:remarks> <maml:para>Shows what clean targets would be removed without deleting anything.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-StaticSite</command:name> <command:verb>New</command:verb> <command:noun>StaticSite</command:noun> <maml:description> <maml:para>Creates a new Hyde site scaffold.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>New-StaticSite creates a new static site folder with Hyde-compatible structure and starter files.</maml:para> <maml:para>By default, the command creates a richer starter scaffold that includes a default layout, starter pages, and a basic stylesheet. Use -Blank to create a minimal scaffold.</maml:para> <maml:para>If the destination already exists and is non-empty, the command fails to avoid overwriting existing content.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-StaticSite</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Destination</maml:name> <maml:description> <maml:para>Required destination path where the new site scaffold will be created.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Blank</maml:name> <maml:description> <maml:para>Creates a minimal scaffold instead of the default starter layout/content files.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Quiet</maml:name> <maml:description> <maml:para>Suppresses informational output and emits only warnings/errors unless verbose output is enabled.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Destination</maml:name> <maml:description> <maml:para>Required destination path where the new site scaffold will be created.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Blank</maml:name> <maml:description> <maml:para>Creates a minimal scaffold instead of the default starter layout/content files.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Quiet</maml:name> <maml:description> <maml:para>Suppresses informational output and emits only warnings/errors unless verbose output is enabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.IO.DirectoryInfo</maml:name> </dev:type> <maml:description> <maml:para>Returns the destination directory object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert /> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>New-StaticSite -Destination .\mysite</dev:code> <dev:remarks> <maml:para>Creates a new Hyde site with starter layouts, pages, and CSS.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>New-StaticSite -Destination .\mysite -Blank</dev:code> <dev:remarks> <maml:para>Creates a minimal Hyde scaffold with only essential files.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>New-StaticSite -Destination .\mysite -WhatIf</dev:code> <dev:remarks> <maml:para>Shows the scaffold creation operations without writing files.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-StaticSiteTheme</command:name> <command:verb>New</command:verb> <command:noun>StaticSiteTheme</command:noun> <maml:description> <maml:para>Creates a new Hyde theme scaffold.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>`New-StaticSiteTheme` scaffolds a starter Hyde theme at the target destination.</maml:para> <maml:para>By default, it creates a previewable scaffold that includes an `index.md` page so the generated structure can be built immediately.</maml:para> <maml:para>When `-Portable` is used, it creates a reusable package-style scaffold without preview content pages.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-StaticSiteTheme</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Destination</maml:name> <maml:description> <maml:para>Path where the theme scaffold should be created.</maml:para> <maml:para>If the destination exists, it must be empty.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Portable</maml:name> <maml:description> <maml:para>Creates a reusable package-style scaffold without preview content pages.</maml:para> <maml:para>Portable mode omits `index.md` and keeps only shared theme structure.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Destination</maml:name> <maml:description> <maml:para>Path where the theme scaffold should be created.</maml:para> <maml:para>If the destination exists, it must be empty.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Portable</maml:name> <maml:description> <maml:para>Creates a reusable package-style scaffold without preview content pages.</maml:para> <maml:para>Portable mode omits `index.md` and keeps only shared theme structure.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.IO.DirectoryInfo</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Theme scaffolding in Hyde is intentionally file-generation only.</maml:para> <maml:para>This command does not install, apply, or distribute themes.</maml:para> <maml:para>The default previewable mode favors quick iteration by including a build target.</maml:para> <maml:para>Portable mode favors reuse by producing only layout/include/style assets.</maml:para> <maml:para>The scaffold uses `_sass` plus `assets/css/site.scss` on purpose: - Hyde defaults `sass.sass_dir` to `_sass`.</maml:para> <maml:para>- The current built-in Sass path is LibSass-based.</maml:para> <maml:para>- Generated Sass uses classic `@import` intentionally for current compatibility.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>New-StaticSiteTheme -Destination .\mytheme</dev:code> <dev:remarks> <maml:para>Creates a previewable theme scaffold in `./mytheme`.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>New-StaticSiteTheme -Destination .\mytheme -Portable</dev:code> <dev:remarks> <maml:para>Creates a portable theme scaffold in `./mytheme`.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>Hyde New-Theme .\mytheme</dev:code> <dev:remarks> <maml:para>Runs the same scaffold flow through the top-level Hyde command.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Publish-StaticSite</command:name> <command:verb>Publish</command:verb> <command:noun>StaticSite</command:noun> <maml:description> <maml:para>Builds and publishes a Hyde static site.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Publish-StaticSite performs a full Hyde build pipeline:</maml:para> <maml:para>- initializes site context and configuration</maml:para> <maml:para>- discovers documents and static files</maml:para> <maml:para>- prepares document metadata/front matter</maml:para> <maml:para>- synchronizes posts, pagination, and taxonomies</maml:para> <maml:para>- renders published documents</maml:para> <maml:para>- copies static assets</maml:para> <maml:para></maml:para> <maml:para>The command returns the full Hyde build context so callers can inspect build state, discovered items, and output metadata.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Publish-StaticSite</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Source</maml:name> <maml:description> <maml:para>Optional source path for the site. When omitted, Hyde uses default source discovery.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Destination</maml:name> <maml:description> <maml:para>Optional destination path override for generated output.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Environment</maml:name> <maml:description> <maml:para>Required environment name used for context initialization and environment-specific settings.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>ScriptPath</maml:name> <maml:description> <maml:para>Internal/back-compat parameter for wrapper invocation. Not intended for normal use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>ModuleRoot</maml:name> <maml:description> <maml:para>Internal override for Hyde module root resolution. Not intended for normal use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"> <maml:name>Version</maml:name> <maml:description> <maml:para>Internal override for reported Hyde version. Not intended for normal use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Quiet</maml:name> <maml:description> <maml:para>Suppresses informational output and emits only warnings/errors unless verbose output is enabled.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Source</maml:name> <maml:description> <maml:para>Optional source path for the site. When omitted, Hyde uses default source discovery.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Destination</maml:name> <maml:description> <maml:para>Optional destination path override for generated output.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Environment</maml:name> <maml:description> <maml:para>Required environment name used for context initialization and environment-specific settings.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Quiet</maml:name> <maml:description> <maml:para>Suppresses informational output and emits only warnings/errors unless verbose output is enabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>ScriptPath</maml:name> <maml:description> <maml:para>Internal/back-compat parameter for wrapper invocation. Not intended for normal use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>ModuleRoot</maml:name> <maml:description> <maml:para>Internal override for Hyde module root resolution. Not intended for normal use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"> <maml:name>Version</maml:name> <maml:description> <maml:para>Internal override for reported Hyde version. Not intended for normal use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>HydeBuildContext</maml:name> </dev:type> <maml:description> <maml:para>Returns the populated build context for the completed run.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert /> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Publish-StaticSite -Source .\site -Destination .\site\_site -Environment development</dev:code> <dev:remarks> <maml:para>Builds a site from .\site into .\site_site using the development environment.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Publish-StaticSite -Source .\site -Environment production -Verbose</dev:code> <dev:remarks> <maml:para>Builds using production context and emits detailed build phase tracing.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>Publish-StaticSite -Source .\site -Destination .\site\_site -Environment development -WhatIf</dev:code> <dev:remarks> <maml:para>Shows file writes/copies that would occur without modifying output.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Test-StaticSite</command:name> <command:verb>Test</command:verb> <command:noun>StaticSite</command:noun> <maml:description> <maml:para>Validates Hyde site health before build.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Test-StaticSite runs Hyde "doctor" validation checks against the current site context.</maml:para> <maml:para>The command initializes context, discovers documents/static files, and runs content validation checks to report issues before a publish run. Results include a health flag and issue list that can be used in CI or local preflight checks.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Test-StaticSite</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Source</maml:name> <maml:description> <maml:para>Optional source path for the site under test.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Destination</maml:name> <maml:description> <maml:para>Optional destination override used while preparing test context.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Environment</maml:name> <maml:description> <maml:para>Environment name used for context initialization. Defaults to `development`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Development</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>ScriptPath</maml:name> <maml:description> <maml:para>Internal/back-compat parameter for wrapper invocation. Not intended for normal use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>ModuleRoot</maml:name> <maml:description> <maml:para>Internal override for Hyde module root resolution. Not intended for normal use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"> <maml:name>Version</maml:name> <maml:description> <maml:para>Internal override for reported Hyde version. Not intended for normal use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Quiet</maml:name> <maml:description> <maml:para>Suppresses informational output and emits only warnings/errors unless verbose output is enabled.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Source</maml:name> <maml:description> <maml:para>Optional source path for the site under test.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Destination</maml:name> <maml:description> <maml:para>Optional destination override used while preparing test context.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Environment</maml:name> <maml:description> <maml:para>Environment name used for context initialization. Defaults to `development`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Development</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Quiet</maml:name> <maml:description> <maml:para>Suppresses informational output and emits only warnings/errors unless verbose output is enabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>ScriptPath</maml:name> <maml:description> <maml:para>Internal/back-compat parameter for wrapper invocation. Not intended for normal use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>ModuleRoot</maml:name> <maml:description> <maml:para>Internal override for Hyde module root resolution. Not intended for normal use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"> <maml:name>Version</maml:name> <maml:description> <maml:para>Internal override for reported Hyde version. Not intended for normal use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> </dev:type> <maml:description> <maml:para>Returns a report with `Healthy` and `Issues` entries.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert /> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Test-StaticSite -Source .\site</dev:code> <dev:remarks> <maml:para>Runs doctor checks for the site rooted at .\site.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Test-StaticSite -Source .\site -Environment production -Verbose</dev:code> <dev:remarks> <maml:para>Runs validation with production context and detailed trace output.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>$report = Test-StaticSite -Source .\site -Quiet if (-not $report.Healthy) { $report.Issues }</dev:code> <dev:remarks> <maml:para>Captures validation report for scripting/automation.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> </helpItems> |