@proactive-as/powershell-documentation-markdown v1.1.1

Solution Description

The module contains functionality to export function documentation from PowerShell functions aswell as from -Help.xml files generated using ProActive.PowerShell.Documentation.

Key Features

• Extracting function documentation from PS1 files.
• Extracting function documentation from -Help.xml files.

Technical Architecture

The module contains a number of PowerShell functions used to extract comments from code and save them as markdown.

Functions:

• New-Documentation

Helper functions:

• New-NuspecDescription
• Export-HelpXML
• Export-PS1
• Get-PS1CommentValue
• New-PS1Markdown
• New-XMLMarkdown
• New-YAMLHeader
• Merge-Hashtables
• Save-MarkdownFile

Other Things

Software limitations:

none known.

Future Changes :

• TypeScript support