51 lines
1.5 KiB
PowerShell
51 lines
1.5 KiB
PowerShell
function New-Docs {
|
|
<#
|
|
.SYNOPSIS
|
|
Creates a ne set of markdown based help in the docs folder.
|
|
|
|
.DESCRIPTION
|
|
This Cmdlet should be used once locally, or after adding new functions. The function `Update-Docs`
|
|
can be used via pipeline to keep the docs up to date.
|
|
.INPUTS
|
|
[None] No pipeline input.
|
|
|
|
.OUTPUTS
|
|
[None] No pipeline output.
|
|
|
|
.EXAMPLE
|
|
New-Docs
|
|
#>
|
|
[CmdletBinding()]
|
|
[Diagnostics.CodeAnalysis.SuppressMessageAttribute(
|
|
'PSUseSingularNouns',
|
|
'',
|
|
Justification = 'New-Doc already in use by other popular modules.'
|
|
)]
|
|
[Diagnostics.CodeAnalysis.SuppressMessageAttribute(
|
|
'PSUseShouldProcessForStateChangingFunctions',
|
|
'',
|
|
Justification = 'system state does not change permanent in temp build clients.'
|
|
)]
|
|
param ()
|
|
|
|
process {
|
|
$Repo = Get-RepoPath
|
|
Import-Module $Repo.Src.Manifest.Item.FullName -Global -Force
|
|
Import-Module -Name 'platyPS'
|
|
$MarkdownParams = @{
|
|
Module = $Repo.Artifact
|
|
OutputFolder = $Repo.Docs.Path
|
|
WithModulePage = $true
|
|
ModulePagePath = $Repo.Docs.ModulePagePath
|
|
Force = $true
|
|
}
|
|
New-MarkdownHelp @MarkdownParams
|
|
|
|
$Docs = Get-Item -Path $Repo.Docs.MarkdownFilter
|
|
foreach ($Doc in $Docs) {
|
|
Write-Verbose -Message ('Converting {0}' -f $Doc.FullName)
|
|
Set-EOL -Path $Doc
|
|
}
|
|
}
|
|
}
|