PowerShell/docs/convert-docx2md.md

85 lines
2.1 KiB
Markdown
Raw Normal View History

2024-01-25 13:37:12 +01:00
Script: *convert-docx2md.ps1*
========================
2023-05-26 12:20:18 +02:00
This PowerShell script converts .DOCX file(s) into Markdown.
2023-07-29 10:04:38 +02:00
Parameters
----------
2023-05-26 12:20:18 +02:00
```powershell
2023-07-29 10:15:44 +02:00
PS> ./convert-docx2md.ps1 [[-FilePattern] <String>] [<CommonParameters>]
2023-05-26 12:20:18 +02:00
-FilePattern <String>
Specifies the file pattern to the .DOCX 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.
```
2023-07-29 10:04:38 +02:00
Example
-------
2023-05-26 12:20:18 +02:00
```powershell
PS> ./convert-docx2md *.docx
```
2023-07-29 10:04:38 +02:00
Notes
-----
2023-05-26 12:20:18 +02:00
Author: Markus Fleschutz | License: CC0
2023-07-29 10:04:38 +02:00
Related Links
-------------
2023-05-26 12:20:18 +02:00
https://github.com/fleschutz/PowerShell
2023-07-29 10:04:38 +02:00
Script Content
--------------
2023-05-26 12:20:18 +02:00
```powershell
<#
.SYNOPSIS
Converts .DOCX file(s) into Markdown
.DESCRIPTION
This PowerShell script converts .DOCX file(s) into Markdown.
.PARAMETER FilePattern
Specifies the file pattern to the .DOCX file(s)
.EXAMPLE
PS> ./convert-docx2md *.docx
.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 .DOCX 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 + ".md"
& pandoc -f docx -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
}
```
2024-03-27 17:36:59 +01:00
*(generated by convert-ps2md.ps1 using the comment-based help of convert-docx2md.ps1 as of 03/27/2024 17:36:25)*