Skip to content

Markdown Not Properly Converted to MAML Help #839

@netsec4u

Description

@netsec4u

Prerequisites

  • Write a descriptive title.
  • Make sure you are able to repro it on the latest version
  • Search the existing issues.

Steps to reproduce

Consider the markdown help file with the example section as below in a file called Get-Widget.md.

## EXAMPLES

### Example 1 - Get a widget by name

```powershell
Get-Widget -Name "Widget1"

Returns the widget called Widget1.


Next run the command below.

```powershell
Import-MarkdownCommandHelp -Path .\Get-Widget.md | Export-MamlCommandHelp -OutputFolder .\maml

This results in the help section being put into the Introduction section of the MAML example node, when it should be split up and put into the Code and Remarks nodes.

Expected behavior

Expected for the Examples section of the MAML to be as below.


    <command:example>
        <maml:title>--------- Example 1 - Get a widget by name ---------</maml:title>
        <maml:introduction />
        <maml:code>
          <maml:para>Get-Widget -Name "Widget1"</maml:para>
        </maml:code>
        <dev:code />
        <dev:remarks>
          <maml:para>Returns the widget called Widget1.</maml:para>
        <dev:remarks>
      </command:example>

Actual behavior

The actual Examples section is as below.


    <command:example>
        <maml:title>--------- Example 1 - Get a widget by name ---------</maml:title>
        <maml:introduction>
          <maml:para>
Get-Widget -Name "Widget1"
</maml:para>
          <maml:para>&#x80;</maml:para>
          <maml:para>Returns the widget called Widget1.</maml:para>
        </maml:introduction>
        <dev:code />
        <dev:remarks />
      </command:example>

Error details

No error.

Environment data

Name                           Value
----                           -----
PSVersion                      7.5.4
PSEdition                      Core
GitCommitId                    7.5.4
OS                             Microsoft Windows 10.0.26100
Platform                       Win32NT
PSCompatibleVersions           {1.0, 2.0, 3.0, 4.0…}
PSRemotingProtocolVersion      2.3
SerializationVersion           1.1.0.1
WSManStackVersion              3.0

Version

1.0.1

Visuals

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions