diff --git a/New-GitHubMarkdownIndex/New-GitHubMarkdownIndex.ps1 b/New-GitHubMarkdownIndex/New-GitHubMarkdownIndex.ps1 index 7b85464..19ba30b 100644 --- a/New-GitHubMarkdownIndex/New-GitHubMarkdownIndex.ps1 +++ b/New-GitHubMarkdownIndex/New-GitHubMarkdownIndex.ps1 @@ -1,4 +1,8 @@ function New-GitHubMarkdownIndex { +<# +.SYNOPSIS +Confusion to generate an index to be used in markdown files +#> param( $Path = 'C:\Temp\Events', $GitHubUri = 'https://github.com/jaapbrasser/events/tree/master' @@ -12,4 +16,4 @@ function New-GitHubMarkdownIndex { "$(" "*$Count*2)* [$(Split-Path $_ -Leaf)]($GitHubUri$GHPath)" } } | clip.exe -} \ No newline at end of file +}