Skip to content

Commit c42d695

Browse files
docs: ✏️ Update documentation for PSWriteHTML module
- Enhanced the `Readme.md` file with updated cmdlet descriptions and added new cmdlets. - Improved the `Save-HTML.md` documentation with detailed parameter descriptions and examples. - Corrected minor formatting issues and ensured consistency across documentation files.
1 parent 06fe855 commit c42d695

171 files changed

Lines changed: 37438 additions & 24560 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

Docs/Add-HTML.md

Lines changed: 95 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -1,60 +1,95 @@
1-
---
2-
external help file: PSWriteHTML-help.xml
3-
Module Name: PSWriteHTML
4-
online version:
5-
schema: 2.0.0
6-
---
7-
8-
# Add-HTML
9-
10-
## SYNOPSIS
11-
{{ Fill in the Synopsis }}
12-
13-
## SYNTAX
14-
15-
```
16-
Add-HTML [[-HTML] <ScriptBlock>] [<CommonParameters>]
17-
```
18-
19-
## DESCRIPTION
20-
{{ Fill in the Description }}
21-
22-
## EXAMPLES
23-
24-
### Example 1
25-
```powershell
26-
PS C:\> {{ Add example code here }}
27-
```
28-
29-
{{ Add example description here }}
30-
31-
## PARAMETERS
32-
33-
### -HTML
34-
{{ Fill HTML Description }}
35-
36-
```yaml
37-
Type: ScriptBlock
38-
Parameter Sets: (All)
39-
Aliases:
40-
41-
Required: False
42-
Position: 0
43-
Default value: None
44-
Accept pipeline input: False
45-
Accept wildcard characters: False
46-
```
47-
48-
### CommonParameters
49-
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
50-
51-
## INPUTS
52-
53-
### None
54-
55-
## OUTPUTS
56-
57-
### System.Object
58-
## NOTES
59-
60-
## RELATED LINKS
1+
---
2+
external help file: PSWriteHTML-help.xml
3+
Module Name: PSWriteHTML
4+
online version: https://github.com/EvotecIT/PSWriteHTML
5+
schema: 2.0.0
6+
---
7+
# Add-HTML
8+
## SYNOPSIS
9+
Adds HTML content to the email body.
10+
11+
## SYNTAX
12+
### __AllParameterSets
13+
```powershell
14+
Add-HTML [[-HTML] <scriptblock>] [<CommonParameters>]
15+
```
16+
17+
## DESCRIPTION
18+
This function adds HTML content to the email body by executing the provided ScriptBlock containing the HTML code.
19+
20+
## EXAMPLES
21+
22+
### EXAMPLE 1
23+
```powershell
24+
$HTMLContent = {
25+
Set-Tag -HtmlObject @{
26+
Tag = 'div'
27+
Attributes = @{
28+
'class' = 'container'
29+
}
30+
Value = 'Hello, World!'
31+
}
32+
}
33+
```
34+
35+
Add-HTML -HTML $HTMLContent
36+
Adds a <div class="container">Hello, World!</div> to the email body.
37+
38+
### EXAMPLE 2
39+
```powershell
40+
$HTMLContent = {
41+
Set-Tag -HtmlObject @{
42+
Tag = 'ul'
43+
Attributes = @{
44+
'id' = 'list'
45+
}
46+
Value = @(
47+
@{
48+
Tag = 'li'
49+
Value = 'Item 1'
50+
}
51+
@{
52+
Tag = 'li'
53+
Value = 'Item 2'
54+
}
55+
)
56+
}
57+
}
58+
```
59+
60+
Add-HTML -HTML $HTMLContent
61+
Adds a list with items 'Item 1' and 'Item 2' to the email body.
62+
63+
## PARAMETERS
64+
65+
### -HTML
66+
Specifies the ScriptBlock containing the HTML code to be added to the email body.
67+
68+
```yaml
69+
Type: ScriptBlock
70+
Parameter Sets: __AllParameterSets
71+
Aliases:
72+
Possible values:
73+
74+
Required: False
75+
Position: 0
76+
Default value: None
77+
Accept pipeline input: False
78+
Accept wildcard characters: True
79+
```
80+
81+
### CommonParameters
82+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
83+
84+
## INPUTS
85+
86+
- `None`
87+
88+
## OUTPUTS
89+
90+
- `None`
91+
92+
## RELATED LINKS
93+
94+
- None
95+

0 commit comments

Comments
 (0)