Set-MarkdownSection

SYNOPSIS

Generates a formatted Markdown section with a specified header level, title, and content.

SYNTAX

__AllParameterSets

Set-MarkdownSection [-Level] <int> [-Title] <string> [-Content] <scriptblock> [<CommonParameters>]

ALIASES

This cmdlet has the following aliases, {{Insert list of aliases}}

DESCRIPTION

This function creates a Markdown section with a specified header level, title, and formatted content. The header level determines the number of # symbols used for the Markdown heading. The content is provided as a script block and executed within the function. The function returns the formatted Markdown as a string.

EXAMPLES

EXAMPLE 1

Set-MarkdownSection -Level 2 -Title "Example Section" -Content { "This is an example of Markdown content." }

Output:

## Example Section

This is an example of Markdown content.

Generates a Markdown section with an H2 heading and the given content.

EXAMPLE 2

Section 2 "Example Section" { "This is an example of Markdown content." }

Output:

## Example Section

This is an example of Markdown content.

Generates a Markdown section with an H2 heading and the given content.

PARAMETERS

-Content

The content to be included in the Markdown section.

Type: System.Management.Automation.ScriptBlock
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 2
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Level

Specifies the Markdown header level (1-6).

Type: System.Int32
DefaultValue: 0
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 0
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Title

The title of the Markdown section.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 1
  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

The formatted Markdown section as a string.

RELATED LINKS