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

No spacing between examples after Update-MarkdownHelpModule #210

Closed
cormacpayne opened this issue Sep 12, 2016 · 2 comments
Closed

No spacing between examples after Update-MarkdownHelpModule #210

cormacpayne opened this issue Sep 12, 2016 · 2 comments
Assignees
Milestone

Comments

@cormacpayne
Copy link

Steps to reproduce

New-MarkdownHelp -Module $module -OutputFolder $moduleFolder -WithModulePage -AlphabeticParamsOrder
Update-MarkdownHelp $moduleFolder -AlphabeticParamsOrder

Expected behavior

Example 1: Foo

PS C:\> Foo

This command does foo.

Example 2: Bar

PS C:\> Bar

This command does bar.

Example 3: Temp

Actual behavior

Example 1: Foo

PS C:\> Foo

This command does foo.

Example 2: Bar

PS C:\> Bar

This command does bar.

Example 3: Temp

Note: I removed the spacing between '###' and 'Example' because markdown will convert it to look as it should, but when Get-HelpPreview is ran on the corresponding MAML, there is no spacing as seen above.

Environment data

v0.7.0

@vors
Copy link
Collaborator

vors commented Sep 13, 2016

Thank you @cormacpayne for reporting the issue!

In regard to your Note, you can use markdown code snippets (with three backticks) to tell github to keep text as-is, without applying markdown formatter. For example

### Example 1: Foo

PS C:\> Foo
This command does foo.
### Example 2: Bar

PS C:\> Bar
This command does bar.
### Example 3: Temp

@vors vors added this to the 0.7.1 milestone Sep 14, 2016
@vors vors self-assigned this Sep 14, 2016
@vors vors added the bug label Sep 14, 2016
@vors
Copy link
Collaborator

vors commented Sep 17, 2016

This is fixed per 15d62cb

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

No branches or pull requests

2 participants