将 PowerShell 转换为 Markdown

在过去一年左右的时间里，我一直在处理 Markdown 文档，主要是因为我一直在 Leanpub.com 上出版的所有书籍。随着 Platyps 等项目中越来越多地使用 Markdown 来生成帮助文件和文档，您很可能在某个时候会使用 Markdown。考虑到这一点，我决定编写一个 PowerShell 函数，该函数将获取管道输出并将其转换为简单的 Markdown 文档，遵循与 ConvertTo-HTML 相同的模型。

学习 Markdown 基础知识大约需要 10 分钟。即使这样，你也不需要了解任何关于 Markdown 的知识就可以使用我的函数。 ConvertTo-Markdown 旨在获取管道输入并将其转换为 Markdown 文档的代码隔离部分。如果您不知道这意味着什么，请不要担心。该函数假设您想要包含顶级标题。不过，如果您正在构建带有 Markdown 片段的文档，则不需要这样做。稍后我将向您展示一个例子。

您需要从 GitHub 获取该函数的副本。

https://gist.github.com/jdhitsolutions/c92fab5b7077799e4ba5da920f0679f0

一旦加载到会话中，您就可以通过管道将命令传递给转换函数。

与 ConvertTo-HTML 一样，这不会创建文件。它仅转换为 Markdown。将命令通过管道传输到 Out-File 或 Set-Content。

该函数还允许您添加 markdown 以在转换后的管道输出之前和之后显示。

get-service win* | 
ConvertTo-Markdown -Title "Win* Services" -PreContent "## $env:computername" -PostContent "_$(Get-Date)_" | 
Out-File c:\work\winsvc.md

最终结果如下：

我认为当您想要创建文档时这会派上用场。这是概念验证脚本。

#SystemMarkdownReport.ps1

param(
[string]$Title = "System Configuration Report",
[string]$Computername = $env:COMPUTERNAME,
[ValidatePattern('\.md$')]
[string]$Filepath = "SystemReport.md"
)

. C:\scripts\Convertto-Markdown.ps1

$PSDefaultParameterValues.add("Get-Ciminstance:computername",$computername)

$pre = @"

This is a system configuration report for $($computername.toupper())
"@

$fragments = @()

$fragments+= ConvertTo-Markdown -Title $title -PreContent $pre

#Computersystem
$prop = 'Manufacturer','Model','SystemFamily','SystemSKUNumber','SystemType','NumberOfLogicalProcessors','NumberofProcessors','TotalPhysicalMemory' 
$cs = Get-CimInstance Win32_Computersystem -ov c -Property $prop | Select-Object -Property $prop 

$class = ($c.cimclass.cimclassname.split("_")[1])
$fragments+= $cs | ConvertTo-Markdown -precontent "## $class"

#volumes
$vol = Get-CimInstance win32_volume -ov c| Select-Object Name,Label,Freespace,Capacity | Format-List
$class = ($c.cimclass.cimclassname.split("_")[1])
$fragments+= $vol | ConvertTo-Markdown -precontent "## $class"

#processor
$cpu = Get-CimInstance win32_processor -ov c | 
Select-Object DeviceID,Name,Caption,MaxClockSpeed,*CacheSize,NumberOf*,SocketDesignation,*Width,Manufacturer
$class = ($c.cimclass.cimclassname.split("_")[1])
$fragments+= $cpu | ConvertTo-Markdown -PreContent "## $class"

#memory
$mem = Get-CimInstance win32_physicalmemory -ov c| Select-Object BankLabel,Capacity,DataWidth,Speed
$class = ($c.cimclass.cimclassname.split("_")[1])
$fragments+= $mem | ConvertTo-Markdown -precontent "## $class"

#networkadapter
$net = Get-NetAdapter -Physical -ov c | Select-Object Name,InterfaceDescription,LinkSpeed
$class="NetworkAdapter"
$fragments+= $net | ConvertTo-Markdown -precontent "## $class"

<#
#system drivers
$sysdrv = Get-CimInstance win32_systemdriver -ov c -filter "State='running'" | 
Select-Object Name,Description,State,StartMode,Started,Pathname,ServiceType | Sort State,Caption
$class = ($c.cimclass.cimclassname.split("_")[1])
$fragments+= $sysdrv | ConvertTo-Markdown -precontent "## $class"
#>

$fragments+= ConvertTo-Markdown -postcontent "_report run $(Get-Date)_"

$fragments | out-file -FilePath $filepath

最终的降价并不总是完美的，因此预计会进行一些细微的调整。

这是创建更复杂的 Markdown 文档的又一个示例。

. C:\scripts\Convertto-Markdown.ps1

$computers = "srv1","srv2","srv4"
$Title = "System Report"
$footer = "_report run $(Get-Date) by $($env:USERDOMAIN)$($env:USERNAME)_"

$sb =  {
$os = get-ciminstance -classname win32_operatingsystem -property caption,lastbootUptime
[PSCustomObject]@{
    PSVersion = $PSVersionTable.PSVersion
    OS = $os.caption
    Uptime = (Get-Date) - $os.lastbootUpTime
    SizeFreeGB = (Get-Volume -DriveLetter C).SizeRemaining /1GB
}
}

$out = Convertto-Markdown -title $Title -PreContent "Here is the system summary information you requested."
foreach ($computer in $computers) {
 $out+= Invoke-command -scriptblock $sb -ComputerName $computer -HideComputerName |
 Select-Object -Property * -ExcludeProperty RunspaceID |
 ConvertTo-Markdown -PreContent "## $($computer.toUpper())"
}
$out += ConvertTo-Markdown -PostContent $footer
$out | set-content c:\work\report.md

我希望您能尝试一下该功能，并告诉我您的想法。如果您想分享任何学习基本 Markdown 的在线教程，那就太好了。享受！