Commit 0ebe828c authored by Laurent Sittler's avatar Laurent Sittler ©

feat: add sample for bulk generation and use `template` parameter for invoke

parent 95001687
......@@ -15,15 +15,18 @@ None. You cannot pipe objects to Update-Month.ps1.
None. Update-Month.ps1 does not generate any output.
.EXAMPLE
C:\PS> Invoke-MdDocs.ps1 -outputFile 'C:\temp\out.md' -scriptFile 'C:\temp\script.ps1'
Create Markdown file `out.md` based on the script file `script.ps1`
.EXAMPLE
C:\PS> Invoke-MdDocs.ps1 -outputFile 'C:\temp\out.md' -scriptFile 'C:\temp\script.ps1' -template 'C:\temp\custom-md.eps'
Create Markdown file `out.md` based on the script file `script.ps1` with a custom template of Markdown output
.EXAMPLE
C:\PS> Get-ChildItem -Path "C:\DocGen" -Recurse -Include "*.ps1" | ForEach { .\Invoke-MdDocs.ps1 -outputFile "C:\DocGen\docs\$($_.Name -replace "\.[^.]+$", ".md")" -scriptFile ($_.FullName) }
Bulk creation of Markdown documentation from a specific folder for all PowerShell `.ps1` files.
.COMPONENT
EPS
.LINK
https://github.com/itpropro/PsDocGen
https://github.com/straightdave/eps
#>
param
......@@ -147,4 +150,4 @@ foreach ($function in $helpContent)
$i++
}
Invoke-EpsTemplate -Path .\md.eps -Safe -Binding @{header = $header; helpContent = $helpContent} | Out-File $outputFile
\ No newline at end of file
Invoke-EpsTemplate -Path $template -Safe -Binding @{header = $header; helpContent = $helpContent} | Out-File $outputFile
\ No newline at end of file
B# Invoke-MdDocs
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment