PowerShell/Docs/convert-md2html.md

78 lines
2.1 KiB
Markdown
Raw Normal View History

2023-05-26 12:20:18 +02:00
## The *convert-md2html.ps1* Script
This PowerShell script converts Markdown file(s) into HTML.
## Parameters
```powershell
/home/mf/Repos/PowerShell/Scripts/convert-md2html.ps1 [[-FilePattern] <String>] [<CommonParameters>]
-FilePattern <String>
Specifies the file pattern to the Markdown file(s)
Required? false
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
[<CommonParameters>]
This script supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction,
WarningVariable, OutBuffer, PipelineVariable, and OutVariable.
```
## Example
```powershell
PS> ./convert-md2html *.md
```
## Notes
Author: Markus Fleschutz | License: CC0
## Related Links
https://github.com/fleschutz/PowerShell
## Source Code
```powershell
<#
.SYNOPSIS
Converts Markdown file(s) into HTML
.DESCRIPTION
This PowerShell script converts Markdown file(s) into HTML.
.PARAMETER FilePattern
Specifies the file pattern to the Markdown file(s)
.EXAMPLE
PS> ./convert-md2html *.md
.LINK
https://github.com/fleschutz/PowerShell
.NOTES
Author: Markus Fleschutz | License: CC0
#>
param([string]$FilePattern = "")
try {
$StopWatch = [system.diagnostics.stopwatch]::startNew()
if ($FilePattern -eq "" ) { $FilePattern = Read-Host "Enter the file pattern to the Markdown file(s)" }
Write-Host "⏳ Searching for pandoc..."
$null = (pandoc --version)
if ($lastExitCode -ne "0") { throw "Can't execute 'pandoc' - make sure it's installed and available" }
Write-Host "⏳ Converting..."
gci -r -i $FilePattern | foreach {
$TargetPath = $_.directoryname + "\" + $_.basename + ".html"
pandoc --standalone --template "$PSScriptRoot/../Data/Templates/template.html" -s $_.name -o $TargetPath
}
[int]$Elapsed = $StopWatch.Elapsed.TotalSeconds
"✔️ converted in $Elapsed sec"
exit 0 # success
} catch {
"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
exit 1
}
```
*Generated by convert-ps2md.ps1 using the comment-based help of convert-md2html.ps1*