Update-ReadmeFromPlatyPSMarkdown.md

external help file	Module Name	online version	schema
PowerBolt-help.xml	PowerBolt	https://github.com/marckassay/PowerBolt/blob/0.0.4/docs/Update-ReadmeFromPlatyPSMarkdown.md	2.0.0

Update-ReadmeFromPlatyPSMarkdown

SYNOPSIS

Adds or updates function's 'snippet' in README file from PlatyPS generated files.

SYNTAX

ByPath (Default)

Update-ReadmeFromPlatyPSMarkdown [[-Path] <String>] [-MarkdownFolder <String>] [-FileName <String>]
 [<CommonParameters>]

ByPipe

Update-ReadmeFromPlatyPSMarkdown [-DocInfo] <MKDocumentationInfo> [-MarkdownFolder <String>]
 [-FileName <String>] [<CommonParameters>]

ByName

Update-ReadmeFromPlatyPSMarkdown [-MarkdownFolder <String>] [-FileName <String>] [-Name] <String>
 [<CommonParameters>]

DESCRIPTION

{{Fill in the Description}}

EXAMPLES

Example 1

PS C:\> {{ Add example code here }}

{{ Add example description here }}

PARAMETERS

-DocInfo

{{Fill DocInfo Description}}

Type: MKDocumentationInfo
Parameter Sets: ByPipe
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-FileName

{{Fill FileName Description}}

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-MarkdownFolder

{{Fill MarkdownFolder Description}}

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Name

{{Fill Name Description}}

Type: String
Parameter Sets: ByName
Aliases:
Accepted values: CimCmdlets, Microsoft.PowerShell.Management, Microsoft.PowerShell.Utility, Pester, Plaster, platyPS, posh-git, PowerBolt, PSReadLine

Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Path

{{Fill Path Description}}

Type: String
Parameter Sets: ByPath
Aliases:

Required: False
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

MKPowerShellDocObject

OUTPUTS

System.Object

NOTES

RELATED LINKS

Update-ReadmeFromPlatyPSMarkdown.ps1

Update-ReadmeFromPlatyPSMarkdown.Tests.ps1

Build-Documentation

Build-PlatyPSMarkdown

New-ExternalHelpFromPlatyPSMarkdown