Skip to content

Commit

Permalink
Updating EZOut tests (re #69)
Browse files Browse the repository at this point in the history
  • Loading branch information
StartAutomating authored and StartAutomating committed Sep 12, 2022
1 parent 6fa13aa commit 3d20202
Showing 1 changed file with 200 additions and 60 deletions.
260 changes: 200 additions & 60 deletions docs/Format-Markdown.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,16 @@ Format-Markdown -ScriptBlock {
### Parameters
#### **InputObject**

|Type |Requried|Postion|PipelineInput |
|----------------|--------|-------|------------------------------|
|```[PSObject]```|false |1 |true (ByValue, ByPropertyName)|
> **Type**: ```[PSObject]```
> **Required**: false
> **Position**: 1
> **PipelineInput**:true (ByValue, ByPropertyName)


---
#### **MarkdownParagraph**

Expand All @@ -38,19 +45,33 @@ This is the default for strings, booleans, numbers, and other primitive types.



|Type |Requried|Postion|PipelineInput |
|--------------|--------|-------|---------------------|
|```[Switch]```|false |named |true (ByPropertyName)|
> **Type**: ```[Switch]```
> **Required**: false
> **Position**: named
> **PipelineInput**:true (ByPropertyName)


---
#### **MarkdownTable**

If set, will generate a markdown table.



|Type |Requried|Postion|PipelineInput |
|--------------|--------|-------|---------------------|
|```[Switch]```|false |named |true (ByPropertyName)|
> **Type**: ```[Switch]```
> **Required**: false
> **Position**: named
> **PipelineInput**:true (ByPropertyName)


---
#### **MarkdownTableAlignment**

Expand All @@ -67,19 +88,33 @@ Valid Values:



|Type |Requried|Postion|PipelineInput |
|----------------|--------|-------|---------------------|
|```[String[]]```|false |2 |true (ByPropertyName)|
> **Type**: ```[String[]]```
> **Required**: false
> **Position**: 2
> **PipelineInput**:true (ByPropertyName)


---
#### **Property**

An array of properties. Providing this implies -MarkdownTable



|Type |Requried|Postion|PipelineInput |
|------------------|--------|-------|---------------------|
|```[PSObject[]]```|false |3 |true (ByPropertyName)|
> **Type**: ```[PSObject[]]```
> **Required**: false
> **Position**: 3
> **PipelineInput**:true (ByPropertyName)


---
#### **Heading**

Expand All @@ -89,9 +124,16 @@ If provided with -InputObject, -Heading will take priority.



|Type |Requried|Postion|PipelineInput |
|--------------|--------|-------|---------------------|
|```[String]```|false |4 |true (ByPropertyName)|
> **Type**: ```[String]```
> **Required**: false
> **Position**: 4
> **PipelineInput**:true (ByPropertyName)


---
#### **HeadingSize**

Expand All @@ -100,39 +142,67 @@ If provided without -Heading, the -InputObject will be considered to be a headin



|Type |Requried|Postion|PipelineInput |
|-------------|--------|-------|---------------------|
|```[Int32]```|false |5 |true (ByPropertyName)|
> **Type**: ```[Int32]```
> **Required**: false
> **Position**: 5
> **PipelineInput**:true (ByPropertyName)


---
#### **Link**

If set, will create a link. The -InputObject will be used as the link content



|Type |Requried|Postion|PipelineInput |
|--------------|--------|-------|---------------------|
|```[String]```|false |6 |true (ByPropertyName)|
> **Type**: ```[String]```
> **Required**: false
> **Position**: 6
> **PipelineInput**:true (ByPropertyName)


---
#### **ImageLink**

If set, will create an image link. The -Inputobject will be used as the link content.



|Type |Requried|Postion|PipelineInput |
|--------------|--------|-------|---------------------|
|```[String]```|false |7 |true (ByPropertyName)|
> **Type**: ```[String]```
> **Required**: false
> **Position**: 7
> **PipelineInput**:true (ByPropertyName)


---
#### **BulletPoint**

If set, will generate a bullet point list.



|Type |Requried|Postion|PipelineInput |
|--------------|--------|-------|---------------------|
|```[Switch]```|false |named |true (ByPropertyName)|
> **Type**: ```[Switch]```
> **Required**: false
> **Position**: named
> **PipelineInput**:true (ByPropertyName)


---
#### **Checkbox**

Expand All @@ -141,19 +211,33 @@ Each piped -InputObject will be an additional list item.



|Type |Requried|Postion|PipelineInput |
|--------------|--------|-------|---------------------|
|```[Switch]```|false |named |true (ByPropertyName)|
> **Type**: ```[Switch]```
> **Required**: false
> **Position**: named
> **PipelineInput**:true (ByPropertyName)


---
#### **Checked**

If set, bullet or numbered list items will be checked.



|Type |Requried|Postion|PipelineInput |
|--------------|--------|-------|---------------------|
|```[Switch]```|false |named |true (ByPropertyName)|
> **Type**: ```[Switch]```
> **Required**: false
> **Position**: named
> **PipelineInput**:true (ByPropertyName)


---
#### **NumberedList**

Expand All @@ -162,9 +246,16 @@ Each piped -InputObject will be an additional list item.



|Type |Requried|Postion|PipelineInput |
|--------------|--------|-------|---------------------|
|```[Switch]```|false |named |true (ByPropertyName)|
> **Type**: ```[Switch]```
> **Required**: false
> **Position**: named
> **PipelineInput**:true (ByPropertyName)


---
#### **BlockQuote**

Expand All @@ -173,9 +264,16 @@ Each line of the -InputObject will be block quoted.



|Type |Requried|Postion|PipelineInput |
|--------------|--------|-------|---------------------|
|```[Switch]```|false |named |true (ByPropertyName)|
> **Type**: ```[Switch]```
> **Required**: false
> **Position**: named
> **PipelineInput**:true (ByPropertyName)


---
#### **BlockQuoteDepth**

Expand All @@ -184,19 +282,33 @@ Each line of the -InputObject will be block quoted.



|Type |Requried|Postion|PipelineInput |
|-------------|--------|-------|---------------------|
|```[Int32]```|false |8 |true (ByPropertyName)|
> **Type**: ```[Int32]```
> **Required**: false
> **Position**: 8
> **PipelineInput**:true (ByPropertyName)


---
#### **Number**

If provided, will create a markdown numbered list with this particular item as the number.



|Type |Requried|Postion|PipelineInput |
|-------------|--------|-------|---------------------|
|```[Int32]```|false |9 |true (ByPropertyName)|
> **Type**: ```[Int32]```
> **Required**: false
> **Position**: 9
> **PipelineInput**:true (ByPropertyName)


---
#### **HorizontalRule**

Expand All @@ -205,19 +317,33 @@ If other parameters are provided, the horiztonal rule will be placed after.



|Type |Requried|Postion|PipelineInput |
|--------------|--------|-------|---------------------|
|```[Switch]```|false |named |true (ByPropertyName)|
> **Type**: ```[Switch]```
> **Required**: false
> **Position**: named
> **PipelineInput**:true (ByPropertyName)


---
#### **Code**

If set, will output the -InputObject as a Markdown code block



|Type |Requried|Postion|PipelineInput |
|--------------|--------|-------|---------------------|
|```[Switch]```|false |named |true (ByPropertyName)|
> **Type**: ```[Switch]```
> **Required**: false
> **Position**: named
> **PipelineInput**:true (ByPropertyName)


---
#### **CodeLanguage**

Expand All @@ -226,19 +352,33 @@ If the -InputObject is a ScriptBlock, -CodeLanguage will be set to PowerShell.



|Type |Requried|Postion|PipelineInput |
|--------------|--------|-------|---------------------|
|```[String]```|false |10 |true (ByPropertyName)|
> **Type**: ```[String]```
> **Required**: false
> **Position**: 10
> **PipelineInput**:true (ByPropertyName)


---
#### **ScriptBlock**

If provided, will output a script block as a Markdown code block.



|Type |Requried|Postion|PipelineInput |
|-------------------|--------|-------|---------------------|
|```[ScriptBlock]```|false |11 |true (ByPropertyName)|
> **Type**: ```[ScriptBlock]```
> **Required**: false
> **Position**: 11
> **PipelineInput**:true (ByPropertyName)


---
### Syntax
```PowerShell
Expand Down

0 comments on commit 3d20202

Please sign in to comment.