Support custom headers

README.md

@@ -10,6 +10,7 @@ Syncs markdown documentation files in a repo to its wiki
 | rootDocsFolder | Relative path within the repo to the root documentation folder | No, default is the repo's root |
 | convertRootReadmeToHomePage | If true, the `README.md` file at the root of the repo will be renamed to `Home.md` in the wiki so that it is used as the wiki homepage | No, default is false |
 | useHeaderForWikiName | If true, will extract the top-line header (denoted by a single `#`) and use that as the wiki page's name. Note: if this results in a name collision the sync will fail | No, default is false and wiki names will be the relative path to the file with `/` converted to `__` (e.g. `path/to/doc.md` becomes `path__to_doc.md`) |
+| useHeaderForWikiName | If set, inserts a header at the top of each wiki file with the given format<br/>Supports the following format subsitutions:<br/>- `{sourceFileLink}`: the absolute url to the source file in the repo | No, default will not add a header |
 
 ## How it works
 

action.ps1

@@ -14,6 +14,7 @@ $defaultBranch  = Get-ActionInput defaultBranch
 $rootDocsFolder = Get-ActionInput rootDocsFolder
 $convertRootReadmeToHomePage = Get-ActionInput convertRootReadmeToHomePage
 $useHeaderForWikiName = Get-ActionInput useHeaderForWikiName
+$customWikiFileHeaderFormat = Get-ActionInput customWikiFileHeaderFormat
 
 $repositoryName = $env:GITHUB_REPOSITORY
 $repositoryUrl = "https://github.com/$repositoryName"
@@ -93,6 +94,11 @@ Function ProcessSourceFile()
         $content = $override.NewContent
     }
 
+    if ($customWikiFileHeaderFormat)
+    {
+        $content = AddCustomHeader $content
+    }
+
     $outputPath = $wikiRepoPath + "/" + $outputFileName
 
     $content | Set-Content -Path $outputPath
@@ -199,6 +205,19 @@ Function UpdateFileLinks()
     $content | % { $linkRegex.Replace($_, $evaluator) }
 }
 
+Function AddCustomHeader()
+{
+    [cmdletbinding()]
+    param([string]$content, $file, [string[]]$directories)
+
+    $header = $customWikiFileHeaderFormat
+
+    $sourceFileLink = "$repositoryUrl/$($directories -join "/")/$($file.Name)"
+    $header = $header -replace "{sourceFileLink}", $sourceFileLink
+
+    "$header`n`n$content"
+}
+
 Function ProcessWikiDirectory()
 {
     [cmdletbinding()]

action.yml

@@ -26,6 +26,14 @@ inputs:
     required: false
     default: false
 
+  customWikiFileHeaderFormat:
+    description: |
+      If set, inserts a header at the top of each wiki file with the given format
+      Supports the following format subsitutions:
+        - {sourceFileLink}: the absolute url to the source file in the repo
+    required: false
+    default:
+
 branding:
   color: purple
   icon: terminal