| external help file | Module Name | online version | schema |
|---|---|---|---|
Bicep-help.xml |
Bicep |
2.0.0 |
Create markdown documentation for bicep files
New-BicepMarkdownDocumentation [[-File] <String>] [-AsString] [-Force]
[<CommonParameters>]
New-BicepMarkdownDocumentation [[-Path] <String>] [-Recurse] [-AsString] [-Force]
[<CommonParameters>]
This command creates a basic markdown documentation of one or more bicep files.
PS C:\> New-BicepMarkdownDocumentation -File C:\MyBicepFile.bicepThis command will create a file called c:\MyBicepFile.md containing basic documentation.
PS C:\> New-BicepMarkdownDocumentation -Path C:\MyBicepFiles\ -Verbose -RecurseThis command will traverse the c:\MyBicepFiles\ folder, including subfolders, and create documentation for all bicep files. The markdown files will be saved with the same name as the bicep files, using .md file extension.
Output the resulting markdown to to the cosole as string.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseBicep file to create documentation from
Type: String
Parameter Sets: FromFile
Aliases:
Required: False
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseNOT IMPLEMENTED!
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalsePath to folder containing bicep files. All files in folder will have markdown documentation created.
Type: String
Parameter Sets: FromFolder
Aliases:
Required: False
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSearch recursively for .bicep files.
Type: SwitchParameter
Parameter Sets: FromFolder
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.