platyPS
platyPS copied to clipboard
Markdown chars in generated help.txt file
Steps to reproduce
Here's the markdown:
## Metadata
The `metadata` section contains information about the Plaster manifest itself and requires the following data:
- `name` - Manifest name. This value is mandatory.
- `id` - The ID is the unique identifier used for the storing users
parameter data and makes sure that the store doesn't get used with another
template. This field is automatically generated if not given a value.
- `version` - Version of the manifest. Defaults to 0.1.0.
- `title` - Manifest name used in menu lists. Defaults to `name`.
- `description` - Manifest description summary.
- `tags` - Tags used to describe the purpose of the template.
- `author` - (Optional) Authors name or details.
Expected behavior
Outputs with the backticks stripped out:
Metadata
The metadata section contains information about the Plaster manifest
itself and requires the following data:
- name - Manifest name. This value is mandatory.
- id - The ID is the unique identifier used for the storing users
parameter data and makes sure that the store doesn't get used with another
template. This field is automatically generated if not given a value. -
version - Version of the manifest. Defaults to 0.1.0.
- title - Manifest name used in menu lists. Defaults to `name`.
- description - Manifest description summary.
- tags - Tags used to describe the purpose of the template.
- author - (Optional) Authors name or details.
An example of the settings explained above can be shown by running
New-PlasterManifest this would give you something similar to the the
following:
Actual behavior
Outputs:
Metadata
The `metadata` section contains information about the Plaster manifest
itself and requires the following data:
- `name` - Manifest name. This value is mandatory.
- `id` - The ID is the unique identifier used for the storing users
parameter data and makes sure that the store doesn't get used with another
template. This field is automatically generated if not given a value. -
`version` - Version of the manifest. Defaults to 0.1.0.
- `title` - Manifest name used in menu lists. Defaults to `name`.
- `description` - Manifest description summary.
- `tags` - Tags used to describe the purpose of the template.
- `author` - (Optional) Authors name or details.
An example of the settings explained above can be shown by running
`New-PlasterManifest` this would give you something similar to the the
following:
Environment data
v0.7.2
In an ideal world, newer PowerShell versions would recognize a help.md file (if the host supports ansi/vt seqs) and would output something like this:

And on down-level versions of PowerShell (or on a host without ansi/vt support) it would fallback to the plain text help.txt file.
Good suggestion! Should be easy to implement.
We believe this issue will be fixed with the change to markdig in our upcoming release.
If this issue is about the About_* files, PlatyPS doesn't process those.
Conversion of cmdlet help has totally changed in Microsoft.PowerShell.PlatyPS v1.