WhatsNew.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Export-BinaryCmdletAliases</command:name> <command:verb>Export</command:verb> <command:noun>BinaryCmdletAliases</command:noun> <maml:description> <maml:para>Extracts cmdlet aliases from a given module.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns a string array of all cmdlet aliases contained in a binary PowerShell cmdlet. Examine the WhatsNew build script (https://github.com/refactorsaurusrex/whats-new/blob/master/build.ps1)for example usage.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Export-BinaryCmdletAliases</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>ModuleInfo</maml:name> <maml:Description> <maml:para>The PSModuleInfo from which to extract cmdlet names.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSModuleInfo</command:parameterValue> <dev:type> <maml:name>PSModuleInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>ModuleInfo</maml:name> <maml:Description> <maml:para>The PSModuleInfo from which to extract cmdlet names.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSModuleInfo</command:parameterValue> <dev:type> <maml:name>PSModuleInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSModuleInfo</maml:name> </dev:type> <maml:description> <maml:para>The PSModuleInfo from which to extract cmdlet names</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-Module WhatsNew -All | Where-Object { $_.ModuleType -eq 'Binary' } | Export-BinaryCmdletAliases</dev:code> <dev:remarks> <maml:para>Returns a string array of all aliases contained in the `WhatsNew` module.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Export-BinaryCmdletAliases</maml:linkText> <maml:uri>https://github.com/refactorsaurusrex/whats-new/wiki/Export-BinaryCmdletAliases</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Export-BinaryCmdletNames</command:name> <command:verb>Export</command:verb> <command:noun>BinaryCmdletNames</command:noun> <maml:description> <maml:para>Extracts cmdlet names from a given module.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns a string array of all cmdlet names contained in a binary PowerShell cmdlet. Examine the WhatsNew build script (https://github.com/refactorsaurusrex/whats-new/blob/master/build.ps1)for example usage.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Export-BinaryCmdletNames</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>ModuleInfo</maml:name> <maml:Description> <maml:para>The PSModuleInfo from which to extract cmdlet names.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSModuleInfo</command:parameterValue> <dev:type> <maml:name>PSModuleInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>ModuleInfo</maml:name> <maml:Description> <maml:para>The PSModuleInfo from which to extract cmdlet names.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSModuleInfo</command:parameterValue> <dev:type> <maml:name>PSModuleInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSModuleInfo</maml:name> </dev:type> <maml:description> <maml:para>The PSModuleInfo from which to extract cmdlet names</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-Module WhatsNew -All | Where-Object { $_.ModuleType -eq 'Binary' } | Export-BinaryCmdletNames Export-BinaryCmdletAliases Export-BinaryCmdletNames Export-PSScriptAliases Export-PSScriptFunctionNames New-MarkdownTableOfContents Switch-CodeFenceToYamlFrontMatter Switch-YamlFrontMatterToCodeFence</dev:code> <dev:remarks> <maml:para>Returns a string array of all cmdlet names contained in the `WhatsNew` module.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Export-BinaryCmdletNames</maml:linkText> <maml:uri>https://github.com/refactorsaurusrex/whats-new/wiki/Export-BinaryCmdletNames</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Export-PSScriptAliases</command:name> <command:verb>Export</command:verb> <command:noun>PSScriptAliases</command:noun> <maml:description> <maml:para>Extracts aliases from a given PowerShell script.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns a simple list of all aliases contained in a particular PowerShell script. Examine the build.ps1 (https://github.com/refactorsaurusrex/whats-new/blob/master/build.ps1)file in this repository for example usage.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Export-PSScriptAliases</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>ScriptFile</maml:name> <maml:Description> <maml:para>The PowerShell script file from which to extract all function names.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>ScriptFile</maml:name> <maml:Description> <maml:para>The PowerShell script file from which to extract all function names.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>The PowerShell script file from which to extract all function names.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-ChildItem -Path "$PSScriptRoot\src\script-modules" -File | Select-Object -ExpandProperty FullName | Export-PSScriptAliases</dev:code> <dev:remarks> <maml:para>This example is taken from the `WhatsNew` build script. It returns all aliases exported from the PowerShell script files contained in this module.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Export-PSScriptAliases</maml:linkText> <maml:uri>https://github.com/refactorsaurusrex/whats-new/wiki/Export-PSScriptAliases</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Export-PSScriptFunctionNames</command:name> <command:verb>Export</command:verb> <command:noun>PSScriptFunctionNames</command:noun> <maml:description> <maml:para>Extracts function names from a given PowerShell script.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns a simple list of all function names contained in a particular PowerShell script. Examine the build.ps1 (https://github.com/refactorsaurusrex/whats-new/blob/master/build.ps1)file in this repository for example usage.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Export-PSScriptFunctionNames</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>ScriptFile</maml:name> <maml:Description> <maml:para>The PowerShell script file from which to extract all function names.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>ScriptFile</maml:name> <maml:Description> <maml:para>The PowerShell script file from which to extract all function names.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>The PowerShell script file from which to extract all function names.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-ChildItem -Path "$PSScriptRoot\src\script-modules" -File | Select-Object -ExpandProperty FullName | Export-PSScriptFunctionNames</dev:code> <dev:remarks> <maml:para>This example is taken from the `WhatsNew` build script. It returns all function names exported from the PowerShell script files contained in this module.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Export-PSScriptFunctionNames</maml:linkText> <maml:uri>https://github.com/refactorsaurusrex/whats-new/wiki/Export-PSScriptFunctionNames</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-MarkdownTableOfContents</command:name> <command:verb>New</command:verb> <command:noun>MarkdownTableOfContents</command:noun> <maml:description> <maml:para>Creates a table of contents for a collection of markdown files, specifically for use with GitHub wiki pages.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Use this command to create a markdown-formatted table of contents that corresponds to a collection of markdown files. This was specifically written in order to create a table of contents like you can see here (https://github.com/refactorsaurusrex/whats-new/wiki#list-of-all-available-commands)on the `WhatsNew` wiki home page. The command assumes each markdown file can be reached online by a predictable URL format, as is the case with GitHub wiki pages.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-MarkdownTableOfContents</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>Either the path to a specific file, or a directory containing a collection of files from which to create a table of contents.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Filter</maml:name> <maml:Description> <maml:para>The search string to match against the names of files in `path`. This parameter can contain a combination of valid literal path and wildcard (* and ?) characters, but it doesn't support regular expressions.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>BaseUrl</maml:name> <maml:Description> <maml:para>The url which should be prepended to the file name to create valid URLs for each table of contents item.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Uri</command:parameterValue> <dev:type> <maml:name>Uri</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>ListType</maml:name> <maml:Description> <maml:para>Specify whether to create an ordered or unordered list. The default is unordered.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Unordered</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>Either the path to a specific file, or a directory containing a collection of files from which to create a table of contents.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Filter</maml:name> <maml:Description> <maml:para>The search string to match against the names of files in `path`. This parameter can contain a combination of valid literal path and wildcard (* and ?) characters, but it doesn't support regular expressions.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>BaseUrl</maml:name> <maml:Description> <maml:para>The url which should be prepended to the file name to create valid URLs for each table of contents item.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Uri</command:parameterValue> <dev:type> <maml:name>Uri</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>ListType</maml:name> <maml:Description> <maml:para>Specify whether to create an ordered or unordered list. The default is unordered.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Unordered</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> New-MarkdownTableOfContents -Path 'C:\Repos\whats-new.wiki' -Filter "*-*.md" -BaseUrl 'https://github.com/refactorsaurusrex/whats-new/wiki' -ListType Unordered</dev:code> <dev:remarks> <maml:para>Creates an unordered markdown list of all the files contained in `C:\Repos\whats-new.wiki` that match the pattern ` - .md`, prepends the `BaseUrl`, and outputs the results. The results of this command can be seen on the WhatsNew wiki home page (https://github.com/refactorsaurusrex/whats-new/wiki#list-of-all-available-commands). BONUS FEATURE: If you install ClipboardText (https://www.powershellgallery.com/packages/ClipboardText/0.1.8), you can pipe the results of the above command to `Set-ClipboardText` and paste wherever you want!</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>New-MarkdownTableOfContents</maml:linkText> <maml:uri>https://github.com/refactorsaurusrex/whats-new/wiki/New-MarkdownTableOfContents</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Switch-CodeFenceToYamlFrontMatter</command:name> <command:verb>Switch</command:verb> <command:noun>CodeFenceToYamlFrontMatter</command:noun> <maml:description> <maml:para>Converts a markdown code fence to yaml front matter.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>If you happen to use platyPS (https://github.com/PowerShell/platyPS) to create markdown documentation for PowerShell modules (as I do), you may have noticed that the metadata platyPS emits as yaml front matter doesn't render all that nicely on GitHub. This command, along with the corresponding `Switch-YamlFrontMatterToCodeFence`, is a bit of a hack that allow you to both keep the metadata and have markdown docs that look pretty on GitHub. All it does is look for a code fence at the top of the file and, if one is found, convert it to yaml front matter. This is useful if you've previous run `Switch-YamlFrontMatterToCodeFence` to get your markdown documentation to display nice and pretty on GitHub but now need to run `Update-MarkdownHelp`, which won't work unless that metadata exists as front matter.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Switch-CodeFenceToYamlFrontMatter</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>The directory containing markdown files with yaml front matter that's previous been converted to a code fence.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NoConfirm</maml:name> <maml:Description> <maml:para>Update the files without prompting first.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>The directory containing markdown files with yaml front matter that's previous been converted to a code fence.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NoConfirm</maml:name> <maml:Description> <maml:para>Update the files without prompting first.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Switch-CodeFenceToYamlFrontMatter -Path "C:\Repos\whats-new.wiki"</dev:code> <dev:remarks> <maml:para>Loads each markdown file found in `C:\Repos\whats-new.wiki`, looks for a code fence at the top of the file, and - if found - converts it to yaml front matter and overwrites the original file with the changes.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Switch-CodeFenceToYamlFrontMatter</maml:linkText> <maml:uri>https://github.com/refactorsaurusrex/whats-new/wiki/Switch-CodeFenceToYamlFrontMatter</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Switch-YamlFrontMatterToCodeFence</command:name> <command:verb>Switch</command:verb> <command:noun>YamlFrontMatterToCodeFence</command:noun> <maml:description> <maml:para>Converts yaml front matter to a markdown code fence.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>If you happen to use platyPS (https://github.com/PowerShell/platyPS) to create markdown documentation for PowerShell modules (as I do), you may have noticed that the metadata platyPS emits as yaml front matter doesn't render all that nicely on GitHub. This command, along with the corresponding `Switch-CodeFenceToYamlFrontMatter`, is a bit of a hack that allow you to both keep the metadata _and_ have markdown docs that look pretty on GitHub. All it does is take the yaml front matter syntax (three dashes) and change it to codefence syntax (three backticks). However, you have to remember to convert the code fence back to yaml before you attempt to run `Update-MarkdownHelp`. Otherwise, you'll run into a parse error.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Switch-YamlFrontMatterToCodeFence</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>The directory containing markdown files with yaml front matter.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NoConfirm</maml:name> <maml:Description> <maml:para>Update the files without prompting first.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>The directory containing markdown files with yaml front matter.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NoConfirm</maml:name> <maml:Description> <maml:para>Update the files without prompting first.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Switch-YamlFrontMatterToCodeFence -Path "C:\Repos\whats-new.wiki"</dev:code> <dev:remarks> <maml:para>Loads each markdown file found in `C:\Repos\whats-new.wiki`, converts any contained yaml front matter to a code fence, and overwrites the original file with the changes.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Switch-YamlFrontMatterToCodeFence</maml:linkText> <maml:uri>https://github.com/refactorsaurusrex/whats-new/wiki/Switch-YamlFrontMatterToCodeFence</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |