ConvertTo-AdrText

NAME ConvertTo-AdrText



SYNOPSIS

Converts an ADR object into ADR markdown.





SYNTAX

ConvertTo-AdrText [-InputObject] <PSObject> [[-Template] <String>] [<CommonParameters>]





DESCRIPTION

Converts an ADR object into ADR markdown via a template. The template will be

sourced from one of the following locations:



- Template parameter on this function

- ADR_TEMPLATE environment variable

- $(Get-AdrDir)/templates/template.md

- A template included in this module





PARAMETERS

-InputObject <PSObject>

A custom object representing the state of the ADR to be rendered.



Required? true

Position? 1

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-Template <String>



Required? false

Position? 2

Default value

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS

System.String







RELATED LINKS