การแปลง PowerShell เป็น Markdown

ฉันทำงานมากกับเอกสารลดราคาในช่วงปีที่ผ่านมา สาเหตุหลักมาจากหนังสือทุกเล่มที่ฉันกำลังทำซึ่งตีพิมพ์ที่ Leanpub.com ด้วยการใช้ Markdown ที่เพิ่มมากขึ้นในโปรเจ็กต์อย่าง Platyps เพื่อสร้างไฟล์วิธีใช้และเอกสารประกอบ คุณน่าจะใช้ Markdown ในบางจุด ด้วยเหตุนี้ ฉันจึงตัดสินใจเขียนฟังก์ชัน PowerShell ที่จะรับเอาต์พุตไปป์ไลน์และแปลงเป็นเอกสารมาร์กดาวน์แบบธรรมดา โดยใช้โมเดลเดียวกันกับ ConvertTo-HTML

การเรียนรู้พื้นฐานมาร์กดาวน์ใช้เวลาประมาณ 10 นาที และถึงอย่างนั้น คุณไม่จำเป็นต้องรู้อะไรเกี่ยวกับมาร์กดาวน์เพื่อใช้ฟังก์ชันของฉัน ConvertTo-Markdown ได้รับการออกแบบมาเพื่อรับอินพุตแบบไปป์ไลน์และแปลงเป็นส่วนที่มีการเข้ารหัสของเอกสาร Markdown หากคุณไม่ทราบว่าสิ่งนี้หมายถึงอะไร ไม่ต้องกังวลกับมัน ฟังก์ชันนี้จะถือว่าคุณจะต้องการใส่ชื่อระดับบนสุด แม้ว่าจะไม่จำเป็นหากคุณกำลังสร้างเอกสารที่มีส่วนมาร์กดาวน์ ฉันจะแสดงตัวอย่างให้คุณดูในภายหลัง

คุณจะต้องคว้าสำเนาของฟังก์ชันจาก GitHub

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

เมื่อโหลดในเซสชันของคุณแล้ว คุณสามารถไพพ์คำสั่งไปยังฟังก์ชันแปลงได้

เช่นเดียวกับ ConvertTo-HTML สิ่งนี้ไม่ได้สร้างไฟล์ มันจะแปลงเป็นมาร์กดาวน์เท่านั้น ไพพ์คำสั่งไปที่ Out-File หรือ Set-Content

ฟังก์ชั่นนี้ยังช่วยให้คุณเพิ่มมาร์กดาวน์เพื่อแสดงก่อนและหลังเอาต์พุตไปป์ไลน์ที่แปลงแล้ว

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

การลดราคาขั้นสุดท้ายไม่ได้สมบูรณ์แบบเสมอไป ดังนั้นคาดว่าจะทำการปรับเปลี่ยนเล็กน้อย

และนี่คืออีกตัวอย่างหนึ่งของการสร้างเอกสารมาร์กดาวน์ที่ซับซ้อนมากขึ้น

. 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

ฉันหวังว่าคุณจะลองใช้ฟังก์ชันนี้และแจ้งให้เราทราบว่าคุณคิดอย่างไร และถ้าคุณต้องการแบ่งปันบทช่วยสอนออนไลน์สำหรับการเรียนรู้มาร์กดาวน์ขั้นพื้นฐาน นั่นคงจะยอดเยี่ยมมาก สนุก!

การแปลง PowerShell เป็น Markdown

บทความที่เกี่ยวข้อง