Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Merge-MarkdownHelp munges multiple syntax blocks together

Open
  • Is something wrong?
#337 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
35/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
markdown, powershell
Domain
documentation, tooling

Research direction

Start with the Merge-MarkdownHelp command and reproduce the issue using the Exchange 2010, 2013, and 2016 Markdown files linked in the report. Compare the merged output with the attached Add-ADPermission files; done means mutually exclusive syntax blocks remain separate and are compared using merge markers.

Written by the indexing model from the issue text.

Description

Area-MergeMarkdown

Steps to reproduce

  1. Take existing markdown files not created by platyPS for Exchange 2010, 2013, and 2016 (see attached).
  2. Run Merge-MarkdownHelp -ExplicitApplicableIfAll -Path "InPath1","InPath2","InPath3" -OutputPath "OutPath"

Expected behavior

Existing syntax blocks are preserved/compared using merge markers

Actual behavior

Existing syntax blocks are combined into one big block containing mutually exclusive parameters (see attached)

Environment data

v0.9.0

Add-ADPermission2016.txt
Add-ADPermissionMerged.txt
Add-ADPermission2010.txt
Add-ADPermission2013.txt

Dominant language
C#
Stars
870
Forks
166
No merged PRs in 30d

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from PowerShell/platyPS

All issues in PowerShell/platyPS

Similar issues

More C# issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.