Initial commit

Generate-ScriptMarkdownHelp.ps1

@@ -0,0 +1,61 @@
+function Generate-ScriptMarkdownHelp {
+    <#    
+    .SYNOPSIS
+        The function that generated the Markdown help in this repository. (see Example for usage). 
+        Generates markdown help for each function containing comment based help in the module (Description not empty) within a folder recursively and a summary table for the main README.md
+    .DESCRIPTION
+        platyPS is used to generate the function level help + the README.md is generated "manually".
+	.PARAMETER Module
+		Name of the Module to generate help for.
+    .PARAMETER RepoUrl
+        Url for the Git repository homepage
+	.EXAMPLE
+       Generate-ScriptMarkdownHelp -Module SearchLucene  -RepoUrl https://github.com/DBremen/SearchLucene
+#>
+    [CmdletBinding()]
+    Param($Module, $RepoUrl)
+    $summaryTable = @'
+# PSDiff
+PowerShell wrapper + additional functionality around the diff part of https://github.com/google/diff-match-patch
+
+This is using a slightly customized version of the c# version provided in the diff-match-patch repository (mainly replacing protected by public and implementing the suggested line and word modes).
+
+![OutConsoleDiff]($($RepoUrl)/blob/master/OutConsoleDiff.PNG)
+For usage check the documentation and the tests.
+The PSDiff module exports the following functions:
+
+
+| Function | Synopsis | Documentation |
+| --- | --- | --- |
+'@
+    Import-Module platyps
+    $htCheck = @{ }
+    Import-Module C:\Scripts\ps1\PSDiff\PSDiff\PSDiff.psm1
+    $functions = Get-Command -Module $Module
+    foreach ($function in $functions) {
+        try {
+            $help = Get-Help $function.Name | Where-Object { $_.Name -eq $function.Name } -ErrorAction Stop
+        }
+        catch {
+            continue
+        }
+        if ($help.description -ne $null) {
+            $htCheck[$function.Name] += 1
+            $link = $help.relatedLinks 
+            if ($link) {
+                $link = $link.navigationLink.uri | Where-Object { $_ -like '*powershellone*' }
+            }
+            $mdFile = $function.Name + '.md'
+            $summaryTable += "`n| $($function.Name) | $($help.Synopsis) | $("[Link]($($RepoUrl)/blob/master/$Module/docs/$mdFile)") |"
+        }
+    }
+    $docFolder = "$(Split-Path (Get-Module $Module)[0].Path)\docs"
+    $summaryTable | Set-Content "$(Split-Path $docFolder -Parent)/README.md" -Force
+    $documenation = New-MarkdownHelp -Module $Module -OutputFolder $docFolder -Force
+    foreach ($file in (dir $docFolder)) {
+        $text = (Get-Content -Path $file.FullName | Select-Object -Skip 6) | Set-Content $file.FullName -Force
+    }
+    #sanity check if help file were generated for each script
+    [PSCustomObject]$htCheck
+}
+Generate-ScriptMarkdownHelp PSDiff -RepoUrl https://github.com/DBremen/PSDiff