Delen via

Measure-PlatyPSMarkdown

Module:
Microsoft.PowerShell.PlatyPS Module

Bepaalt het type Markdown-bestand.

Syntaxis

Path (Standaard) 

Measure-PlatyPSMarkdown
    [-Path] <string[]>
    [<CommonParameters>]

LiteralPath 

Measure-PlatyPSMarkdown
    -LiteralPath <string[]>
    [<CommonParameters>]

Description

De opdracht leest de inhoud van het bestand en bepaalt het type inhoud. De opdracht retourneert een PlatyPSMarkdown--object dat het inhoudstype en de schemaversie van een PlatyPS Markdown-bestand bevat. Dit is handig voor het selecteren van alleen de bestanden die CommandHelp of ModuleHelp inhoud bevatten.

Voorbeelden

Voorbeeld 1: Alle Markdown-bestanden in een map meten

Measure-PlatyPSMarkdown -Path .\v2\Microsoft.PowerShell.PlatyPS\*.md

Title                               Filetype              Filepath
-----                               --------              --------
Compare-CommandHelp                 CommandHelp, V2Schema D:\Git\PS-Src\platyPS\v2docs\v2\Microsoft.PowerShell.PlatyPS\Compare-CommandHelp.md
Export-MamlCommandHelp              CommandHelp, V2Schema D:\Git\PS-Src\platyPS\v2docs\v2\Microsoft.PowerShell.PlatyPS\Export-MamlCommandHelp.md
Export-MarkdownCommandHelp          CommandHelp, V2Schema D:\Git\PS-Src\platyPS\v2docs\v2\Microsoft.PowerShell.PlatyPS\Export-MarkdownCommandHelp.md
Export-MarkdownModuleFile           CommandHelp, V2Schema D:\Git\PS-Src\platyPS\v2docs\v2\Microsoft.PowerShell.PlatyPS\Export-MarkdownModuleFile.md
Export-YamlCommandHelp              CommandHelp, V2Schema D:\Git\PS-Src\platyPS\v2docs\v2\Microsoft.PowerShell.PlatyPS\Export-YamlCommandHelp.md
Export-YamlModuleFile               CommandHelp, V2Schema D:\Git\PS-Src\platyPS\v2docs\v2\Microsoft.PowerShell.PlatyPS\Export-YamlModuleFile.md
Import-MamlHelp                     CommandHelp, V2Schema D:\Git\PS-Src\platyPS\v2docs\v2\Microsoft.PowerShell.PlatyPS\Import-MamlHelp.md
Import-MarkdownCommandHelp          CommandHelp, V2Schema D:\Git\PS-Src\platyPS\v2docs\v2\Microsoft.PowerShell.PlatyPS\Import-MarkdownCommandHelp.md
Import-MarkdownModuleFile           CommandHelp, V2Schema D:\Git\PS-Src\platyPS\v2docs\v2\Microsoft.PowerShell.PlatyPS\Import-MarkdownModuleFile.md
Import-YamlCommandHelp              CommandHelp, V2Schema D:\Git\PS-Src\platyPS\v2docs\v2\Microsoft.PowerShell.PlatyPS\Import-YamlCommandHelp.md
Import-YamlModuleFile               CommandHelp, V2Schema D:\Git\PS-Src\platyPS\v2docs\v2\Microsoft.PowerShell.PlatyPS\Import-YamlModuleFile.md
Measure-PlatyPSMarkdown             CommandHelp, V2Schema D:\Git\PS-Src\platyPS\v2docs\v2\Microsoft.PowerShell.PlatyPS\Measure-PlatyPSMarkdown.md
Microsoft.PowerShell.PlatyPS Module ModuleFile, V2Schema  D:\Git\PS-Src\platyPS\v2docs\v2\Microsoft.PowerShell.PlatyPS\Microsoft.PowerShell.PlatyPS.md
New-CommandHelp                     CommandHelp, V2Schema D:\Git\PS-Src\platyPS\v2docs\v2\Microsoft.PowerShell.PlatyPS\New-CommandHelp.md
New-MarkdownCommandHelp             CommandHelp, V2Schema D:\Git\PS-Src\platyPS\v2docs\v2\Microsoft.PowerShell.PlatyPS\New-MarkdownCommandHelp.md
New-MarkdownModuleFile              CommandHelp, V2Schema D:\Git\PS-Src\platyPS\v2docs\v2\Microsoft.PowerShell.PlatyPS\New-MarkdownModuleFile.md
Test-MarkdownCommandHelp            CommandHelp, V2Schema D:\Git\PS-Src\platyPS\v2docs\v2\Microsoft.PowerShell.PlatyPS\Test-MarkdownCommandHelp.md
Update-CommandHelp                  CommandHelp, V2Schema D:\Git\PS-Src\platyPS\v2docs\v2\Microsoft.PowerShell.PlatyPS\Update-CommandHelp.md
Update-MarkdownCommandHelp          CommandHelp, V2Schema D:\Git\PS-Src\platyPS\v2docs\v2\Microsoft.PowerShell.PlatyPS\Update-MarkdownCommandHelp.md
Update-MarkdownModuleFile           CommandHelp, V2Schema D:\Git\PS-Src\platyPS\v2docs\v2\Microsoft.PowerShell.PlatyPS\Update-MarkdownModuleFile.md

Parameters

-LiteralPath

Hiermee geeft u een pad naar een of meer Markdown-bestanden. De waarde van LiteralPath- wordt precies gebruikt zoals deze is getypt. Er worden geen tekens geïnterpreteerd als jokertekens. Als het pad escape-tekens bevat, zet het dan tussen enkele aanhalingstekens. Enkele aanhalingstekens zorgen ervoor dat PowerShell geen tekens als escapesequenties interpreteert.

Zie about_Quoting_Rulesvoor meer informatie.

Parametereigenschappen

Type:

String[]

Default value:None
Ondersteunt jokertekens:False
DontShow:False
Aliassen:PSPath, LP

Parametersets

LiteralPath
Position:Named
Verplicht:True
Waarde uit pijplijn:True
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-Path

Het pad naar een of meer Markdown-bestanden. Specificeert een pad naar een of meer locaties.

Parametereigenschappen

Type:

String[]

Default value:None
Ondersteunt jokertekens:True
DontShow:False

Parametersets

Path
Position:0
Verplicht:True
Waarde uit pijplijn:True
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

CommonParameters

Deze cmdlet ondersteunt de algemene parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction en -WarningVariable. Zie about_CommonParametersvoor meer informatie.

Invoerwaarden

String

Uitvoerwaarden

Microsoft.PowerShell.PlatyPS.MarkdownProbeInfo

Notities

Voor markdown-bestanden met oude indeling onderzoekt de opdracht de frontmatter- en H2-structuur om het inhoudstype te bepalen. Voor markdown-bestanden met een nieuwe indeling onderzoekt de opdracht de document type sleutel in de frontmatter.

De opdracht valideert niet de volledige structuur van het Markdown-bestand. Gebruik Test-MarkdownCommandHelp om de structuur van het Markdown-bestand te valideren.