Set-MarkdownDetails¶
SYNOPSIS¶
Generates a collapsible Markdown details block.
SYNTAX¶
__AllParameterSets¶
Set-MarkdownDetails [-Title] <string> [-Content] <scriptblock> [<CommonParameters>]
ALIASES¶
This cmdlet has the following aliases, {{Insert list of aliases}}
DESCRIPTION¶
This function creates a collapsible Markdown <details> block with a summary title
and formatted content.
It captures the output of the provided script block and
wraps it in a Markdown details structure.
EXAMPLES¶
EXAMPLE 1¶
Set-MarkdownDetails -Title 'More Information' -Content { 'This is detailed content.' }
Output:
<details><summary>More Information</summary>
<p>
This is detailed content.
</p>
</details>
Generates a Markdown details block with the title "More Information" and the specified content.
EXAMPLE 2¶
Details 'More Information' { 'This is detailed content.' }
Output:
<details><summary>More Information</summary>
<p>
This is detailed content.
</p>
</details>
Generates a Markdown details block with the title "More Information" and the specified content.
PARAMETERS¶
-Content¶
The content inside the Markdown details block.
Type: System.Management.Automation.ScriptBlock
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
Position: 1
IsRequired: true
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-Title¶
The title of the Markdown details block.
Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
Position: 0
IsRequired: true
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
CommonParameters¶
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
INPUTS¶
OUTPUTS¶
string¶
{{ Fill in the Description }}
System.String¶
{{ Fill in the Description }}
NOTES¶
Returns the formatted Markdown details block as a string.