From d1d39c21483e7a29e4119679784c05e28c0e1dd9 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Tue, 26 Mar 2024 23:02:39 +0100 Subject: [PATCH 1/6] Fix docs --- scripts/helpers/Build/Build-PSModuleDocumentation.ps1 | 9 ++++++++- tests/src/PSModuleTest/public/New-PSModuleTest.ps1 | 3 +++ 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/scripts/helpers/Build/Build-PSModuleDocumentation.ps1 b/scripts/helpers/Build/Build-PSModuleDocumentation.ps1 index d511e25..9f84134 100644 --- a/scripts/helpers/Build/Build-PSModuleDocumentation.ps1 +++ b/scripts/helpers/Build/Build-PSModuleDocumentation.ps1 @@ -41,13 +41,20 @@ function Build-PSModuleDocumentation { $fixedOpening = $true } elseif ($line -match '^```.+$') { $fixedOpening = $true - } elseif ($line -match '^```$'){ + } elseif ($line -match '^```$') { $fixedOpening = $false } $newContent += $line } $newContent | Set-Content -Path $_.FullName } + Get-ChildItem -Path $DocsOutputFolder -Recurse -Force -Include '*.md' | ForEach-Object { + $content = Get-Content -Path $_.FullName + $content = $content -replace "\``", "``" + $content = $content -replace '\[', '[' + $content = $content -replace '\]', ']' + $content | Set-Content -Path $_.FullName + } Stop-LogGroup Get-ChildItem -Path $DocsOutputFolder -Recurse -Force -Include '*.md' | ForEach-Object { diff --git a/tests/src/PSModuleTest/public/New-PSModuleTest.ps1 b/tests/src/PSModuleTest/public/New-PSModuleTest.ps1 index 7f26215..33b6e1d 100644 --- a/tests/src/PSModuleTest/public/New-PSModuleTest.ps1 +++ b/tests/src/PSModuleTest/public/New-PSModuleTest.ps1 @@ -9,6 +9,9 @@ function New-PSModuleTest { Test-PSModule -Name 'World' "Hello, World!" + + .NOTES + Testing if a module can have a [Markdown based link](https://example.com). #> [Diagnostics.CodeAnalysis.SuppressMessageAttribute( 'PSUseShouldProcessForStateChangingFunctions', '', Scope = 'Function', From 08c71db46e8f478c6467782d63fd52aaf9f650a5 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Tue, 26 Mar 2024 23:08:08 +0100 Subject: [PATCH 2/6] test --- scripts/helpers/Build/Build-PSModuleDocumentation.ps1 | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/scripts/helpers/Build/Build-PSModuleDocumentation.ps1 b/scripts/helpers/Build/Build-PSModuleDocumentation.ps1 index 9f84134..fa9efde 100644 --- a/scripts/helpers/Build/Build-PSModuleDocumentation.ps1 +++ b/scripts/helpers/Build/Build-PSModuleDocumentation.ps1 @@ -49,7 +49,7 @@ function Build-PSModuleDocumentation { $newContent | Set-Content -Path $_.FullName } Get-ChildItem -Path $DocsOutputFolder -Recurse -Force -Include '*.md' | ForEach-Object { - $content = Get-Content -Path $_.FullName + $content = Get-Content -Path $_.FullName -Raw $content = $content -replace "\``", "``" $content = $content -replace '\[', '[' $content = $content -replace '\]', ']' @@ -60,7 +60,7 @@ function Build-PSModuleDocumentation { Get-ChildItem -Path $DocsOutputFolder -Recurse -Force -Include '*.md' | ForEach-Object { $fileName = $_.Name $hash = (Get-FileHash -Path $_.FullName -Algorithm SHA256).Hash - Start-LogGroup "- File: [$fileName] - [$hash]" + Start-LogGroup " - [$fileName] - [$hash]" Show-FileContent -Path $_ Stop-LogGroup } From f1f936cb11efd5837f110668db2e32cc2e736991 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Tue, 26 Mar 2024 23:10:30 +0100 Subject: [PATCH 3/6] test --- scripts/helpers/Build/Build-PSModuleDocumentation.ps1 | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/scripts/helpers/Build/Build-PSModuleDocumentation.ps1 b/scripts/helpers/Build/Build-PSModuleDocumentation.ps1 index fa9efde..8f073aa 100644 --- a/scripts/helpers/Build/Build-PSModuleDocumentation.ps1 +++ b/scripts/helpers/Build/Build-PSModuleDocumentation.ps1 @@ -50,9 +50,9 @@ function Build-PSModuleDocumentation { } Get-ChildItem -Path $DocsOutputFolder -Recurse -Force -Include '*.md' | ForEach-Object { $content = Get-Content -Path $_.FullName -Raw - $content = $content -replace "\``", "``" - $content = $content -replace '\[', '[' - $content = $content -replace '\]', ']' + $content = $content -replace "\\``", "``" + $content = $content -replace '\\[', '[' + $content = $content -replace '\\]', ']' $content | Set-Content -Path $_.FullName } Stop-LogGroup From 693b555b3d86682e9acacb9dda46f7e8004b8a07 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Tue, 26 Mar 2024 23:12:47 +0100 Subject: [PATCH 4/6] test --- scripts/helpers/Build/Build-PSModuleDocumentation.ps1 | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/scripts/helpers/Build/Build-PSModuleDocumentation.ps1 b/scripts/helpers/Build/Build-PSModuleDocumentation.ps1 index 8f073aa..4913255 100644 --- a/scripts/helpers/Build/Build-PSModuleDocumentation.ps1 +++ b/scripts/helpers/Build/Build-PSModuleDocumentation.ps1 @@ -50,9 +50,9 @@ function Build-PSModuleDocumentation { } Get-ChildItem -Path $DocsOutputFolder -Recurse -Force -Include '*.md' | ForEach-Object { $content = Get-Content -Path $_.FullName -Raw - $content = $content -replace "\\``", "``" - $content = $content -replace '\\[', '[' - $content = $content -replace '\\]', ']' + $content = $content -replace '\\`', '`' + $content = $content -replace '\\\[', '[' + $content = $content -replace '\\\]', ']' $content | Set-Content -Path $_.FullName } Stop-LogGroup From 79f4182bd3449c31b91bdfa50014145ce655ff62 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Tue, 26 Mar 2024 23:16:02 +0100 Subject: [PATCH 5/6] test --- tests/src/PSModuleTest/public/New-PSModuleTest.ps1 | 2 ++ 1 file changed, 2 insertions(+) diff --git a/tests/src/PSModuleTest/public/New-PSModuleTest.ps1 b/tests/src/PSModuleTest/public/New-PSModuleTest.ps1 index 33b6e1d..d97e8f3 100644 --- a/tests/src/PSModuleTest/public/New-PSModuleTest.ps1 +++ b/tests/src/PSModuleTest/public/New-PSModuleTest.ps1 @@ -12,6 +12,8 @@ function New-PSModuleTest { .NOTES Testing if a module can have a [Markdown based link](https://example.com). + !"#¤%&/()=?`´^¨*'-_+§½{[]}<>|@£$€¥¢:;.," + \[This is a test\] #> [Diagnostics.CodeAnalysis.SuppressMessageAttribute( 'PSUseShouldProcessForStateChangingFunctions', '', Scope = 'Function', From e216f948e4af42085418c98a08183fe8d5a7d278 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Tue, 26 Mar 2024 23:18:51 +0100 Subject: [PATCH 6/6] test --- scripts/helpers/Build/Build-PSModuleDocumentation.ps1 | 3 +++ 1 file changed, 3 insertions(+) diff --git a/scripts/helpers/Build/Build-PSModuleDocumentation.ps1 b/scripts/helpers/Build/Build-PSModuleDocumentation.ps1 index 4913255..d598834 100644 --- a/scripts/helpers/Build/Build-PSModuleDocumentation.ps1 +++ b/scripts/helpers/Build/Build-PSModuleDocumentation.ps1 @@ -53,6 +53,9 @@ function Build-PSModuleDocumentation { $content = $content -replace '\\`', '`' $content = $content -replace '\\\[', '[' $content = $content -replace '\\\]', ']' + $content = $content -replace '\\\<', '<' + $content = $content -replace '\\\>', '>' + $content = $content -replace '\\\\', '\' $content | Set-Content -Path $_.FullName } Stop-LogGroup