Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

There is no cmdlet to process about help topics in the Microsoft.PowerShell.PlatyPS #709

Open
peetrike opened this issue Nov 1, 2024 · 3 comments

Comments

@peetrike
Copy link

peetrike commented Nov 1, 2024

Summary of the new feature / enhancement

The old module (PlatyPS) was able to process about help topics from markdown to .help.txt files. The new modules seems to not have that ability.

Proposed technical implementation details (optional)

No response

@peetrike peetrike added Issue-Enhancement Issue is more of a feature request than a bug Needs-Triage The issue is new and needs to be triaged by a work group. labels Nov 1, 2024
@sdwheeler sdwheeler added Idea-Helpv2 and removed Needs-Triage The issue is new and needs to be triaged by a work group. labels Nov 5, 2024
@sdwheeler sdwheeler added Resolution-By Design The reported behavior is by design. and removed Issue-Enhancement Issue is more of a feature request than a bug labels Mar 10, 2025
@sdwheeler
Copy link
Collaborator

The only support the old platyPS module had for about_* topics was to create an empty template. There are no plans to add this to the new version.

@peetrike
Copy link
Author

peetrike commented Mar 10, 2025

platyPS v0.14.2 is able to convert existing about_.md files to about_.help.txt files. The conversion is not the best, but it exists. Specifically, New-ExternalHelp (https://github.com/PowerShell/platyPS/blob/master/src/platyPS/platyPS.psm1#L921-L933) does that.

@sdwheeler sdwheeler removed the Resolution-By Design The reported behavior is by design. label Mar 10, 2025
@sdwheeler sdwheeler reopened this Mar 10, 2025
@sdwheeler
Copy link
Collaborator

Reopen for further investigation. This feature doesn't work with the way we format about_.md files for our publishing system. We use Pandoc to convert the about_.md files in our build system.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants