Skip to content

Remove MarkdownMetadataBlock

dscbot edited this page May 29, 2024 · 3 revisions

Remove-MarkdownMetadataBlock

SYNOPSIS

Removes metadata from a Markdown file.

SYNTAX

Remove-MarkdownMetadataBlock [-FilePath] <FileInfo> [-Force] [-WhatIf]
 [-Confirm] [<CommonParameters>]

DESCRIPTION

The Remove-MarkdownMetadataBlock function removes metadata from a Markdown file. It searches for a metadata marker ('---') and removes the content between the marker and the next occurrence of the marker.

EXAMPLES

EXAMPLE 1

Remove-MarkdownMetadataBlock -FilePath 'C:\Path\To\File.md'

Removes the metadata from the specified Markdown file.

PARAMETERS

-FilePath

Specifies the path to the Markdown file from which the metadata should be removed.

Type: FileInfo
Parameter Sets: (All)
Aliases:

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

-Force

Specifies that the sidebar should be created without any confirmation.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
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.

INPUTS

OUTPUTS

NOTES

RELATED LINKS