ConvertTo-HelpMarkdown

Gets the help content for a command name, or path to .ps1 file, and converts it to a markdown file.

Syntax

ConvertTo-HelpMarkdown.ps1 [-Command] <String> [-FrontMatter] [[-OutputDir] <String>] [-Index] [<CommonParameters>]

Parameters

Name	Description	Required?	Pipeline Input?	Default Value
Command	Name of a cmdlet or path to a .ps1 file	true	true (ByValue)
FrontMatter	Specify to include Jekyll compatible Front Matter in the output	false	false	False
OutputDir	Directory where to output the files	false	false	./help
Index	Specify to generate an index.md file with links to all the help files generated	false	false	False

Notes

Version 1.0.1 (2015-05-14)
Written by Paul Vaillant
Inspired by Out-HTML http://poshcode.org/1612

Examples

EXAMPLE 1

ls .\content\*.ps1 | ConvertTo-HelpMarkdown.ps1 -FrontMatter -Index

Generate markdown help for all the script files in the content directory of a Jekyll site