Skip to content

MarkdownLint - Improve output by fixing MD022 and MD040 #495

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

Closed
DEberhardt opened this issue Jan 9, 2021 · 7 comments
Closed

MarkdownLint - Improve output by fixing MD022 and MD040 #495

DEberhardt opened this issue Jan 9, 2021 · 7 comments
Labels
Area-MarkdownWriter Issue concerns conversion to markdown Resolution-Fixed The issue is fixed.
Milestone

Comments

@DEberhardt
Copy link

Markdownlint in VSCode complains about MD022 and MD040 mostly (MD031 as well, but that goes away with fixing MD022)
As far as I can see, these might be fairly easy to implement

MD022 - Headings should be surrounded by blank lines
MD040 - Fenced code blocks should have a language specified

Environment data

v0.14.0

@DEberhardt
Copy link
Author

#496 addresses MD022

for MD040 I see that the schema already has a text block for the language in the Syntax, but it is empty when built.

@DEberhardt
Copy link
Author

Updated commit now also addresses MD040
Ready

@DEberhardt
Copy link
Author

hm. That doesn't seem to work for me :/

@brianstringfellow
Copy link

I am curious about the state of this issue and pull request #496. Is the merge on hold for now, until v2 release?

@sdwheeler sdwheeler added the Resolution-Fixed The issue is fixed. label May 24, 2024
@sdwheeler
Copy link
Collaborator

This is fixed in Microsoft.PowerShell.PlatyPS v1

@brianstringfellow
Copy link

Sorry to comment after the issue is closed. When I generate documents from my module, the output still doesn't include the newline after the headers. Should this happen with the default configuration or is there a configuration item I need to change?

The version I am using is 0.14.2.

PS>Get-Module platyPS -ListAvailable

    Directory: C:\Program Files\PowerShell\Modules

ModuleType Version    PreRelease Name                
---------- -------    ---------- ----                             
Script     0.14.2                platyPS             

After I import my module firewallPolicies, I then run the following command.

New-MarkdownHelp -Module firewallPolicies -OutputFolder C:\temp\DeleteMe\docs -Force

Example in VS Code
image

@sdwheeler
Copy link
Collaborator

Right, the is not fixed in v0.14.2. We haven't released Microsoft.PowerShell.PlatyPS v1 to the public yet. It is still in development.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area-MarkdownWriter Issue concerns conversion to markdown Resolution-Fixed The issue is fixed.
Projects
None yet
Development

No branches or pull requests

3 participants