Table of Contents

Convert-PnPSiteTemplateToMarkdown

SYNOPSIS

Converts an existing PnP Site Template to a markdown report

SYNTAX

Convert-PnPSiteTemplateToMarkdown -TemplatePath <String> [-Out <String>] [-Force <SwitchParameter>]

DESCRIPTION

Converts an existing PnP Site Template to markdown report. Notice that this cmdlet is work in work progress, and the completeness of the report will increase in the future.

EXAMPLES

EXAMPLE 1

Convert-PnPSiteTemplateToMarkdown -TemplatePath ./mytemplate.xml

This will convert the site template to a markdown file and outputs the result to the console.

EXAMPLE 2

Convert-PnPSiteTemplateToMarkdown -TemplatePath ./mytemplate.xml -Out ./myreport.md

This will convert the site template to a markdown file and writes the result to the specified myreport.md file.

PARAMETERS

-TemplatePath

The path to an existing PnP Site Template

Type: String
Parameter Sets: (All)

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

-Out

The output file name to write the report to in markdown format.

Type: String
Parameter Sets: (All)

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

-Force

Overwrites the output file if it exists.

Type: SwitchParameter
Parameter Sets: (All)

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

Microsoft 365 Patterns and Practices