Add-OfficeMarkdownDetails

Namespace PSWriteOffice

Inputs

OfficeIMO.Markdown.MarkdownDoc

Outputs

OfficeIMO.Markdown.MarkdownDoc

Adds a collapsible Markdown details block.

Remarks

Adds a collapsible Markdown details block.

Examples

Add a details section.


PS>MarkdownDetails -Summary 'Implementation notes' { MarkdownParagraph -Text 'Hidden by default.' }

Appends a details/summary block with nested Markdown content.

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.

Syntax

Add-OfficeMarkdownDetails -Content <ScriptBlock> [-Open] [-PassThru] -Summary <String> [<CommonParameters>]

Parameter set: Context

Parameters

Content ScriptBlock requiredposition: 1pipeline: False: Nested Markdown content rendered inside the details block.
Open SwitchParameter optionalposition: namedpipeline: False: Render the details block as open by default.
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit the updated Markdown document.
Summary String requiredposition: 0pipeline: False: Summary text displayed by the details block.

Outputs

OfficeIMO.Markdown.MarkdownDoc

Add-OfficeMarkdownDetails -Content <ScriptBlock> -Document <MarkdownDoc> [-Open] [-PassThru] -Summary <String> [<CommonParameters>]

Parameter set: Document

Parameters

Content ScriptBlock requiredposition: 1pipeline: False: Nested Markdown content rendered inside the details block.
Document MarkdownDoc requiredposition: namedpipeline: True (ByValue): Markdown document to update outside the DSL context.
Open SwitchParameter optionalposition: namedpipeline: False: Render the details block as open by default.
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit the updated Markdown document.
Summary String requiredposition: 0pipeline: False: Summary text displayed by the details block.

Outputs

OfficeIMO.Markdown.MarkdownDoc