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

Markdown commands should be distributed via the gallery #7423

Open
Jaykul opened this Issue Aug 1, 2018 · 3 comments

Comments

Projects
None yet
2 participants
@Jaykul

Jaykul commented Aug 1, 2018

First of all, users of PowerShell 5 (and 3 and 4) need markdown commands too. Additionally, this steps on multiple third party modules that already exist and are backward compatible.

Finally, I'm really not sure why we need commands for markdown in PowerShell anyway.

I mean, I get that you want to use markdown stuff for help, but obviously you're not expecting people to get help by doing:

$Env:PSModulePath -split [IO.Path]::PathSeparator | 
Get-ChildItem -recurse -filter *.md | 
Get-Content | Select-String MyHelpSearch |
ConvertFrom-Markdown -asVt100 | 
Show-Markdown

Given all that, and the obviously limited Markdown that you can render in the console, there's no need to ship generic markdown cmdlets in the core -- but if you did need them, you should either use an existing third party module, or build your own and ship it to the gallery, not put them in Microsoft.PowerShell.Utility

@Jaykul

This comment has been minimized.

Show comment
Hide comment
@Jaykul

Jaykul Aug 1, 2018

It's worth noting that users of MarkdownEx, for example, now have to add -AllowClobber to install it, and they have to explicitly import it in order to use it, because autoloading won't happen anymore.

Jaykul commented Aug 1, 2018

It's worth noting that users of MarkdownEx, for example, now have to add -AllowClobber to install it, and they have to explicitly import it in order to use it, because autoloading won't happen anymore.

@SteveL-MSFT

This comment has been minimized.

Show comment
Hide comment
@SteveL-MSFT

SteveL-MSFT Aug 1, 2018

Member

MarkdownEx was a project created just 9 hours ago and published today so we couldn't have known about it.

I don't believe these cmdlets preclude use of other third party Markdown cmdlets.

The Markdown Rendering RFC was first published last April so certainly sufficient time to get feedback.

The current cmdlets are on a path for native markdown support for help content and move away from MAML which requires the doc writers to convert from markdown to publish. Additional work in 6.2 timeframe to have this work end-to-end.

The longer term plan is to decouple all modules from PS Core.

Member

SteveL-MSFT commented Aug 1, 2018

MarkdownEx was a project created just 9 hours ago and published today so we couldn't have known about it.

I don't believe these cmdlets preclude use of other third party Markdown cmdlets.

The Markdown Rendering RFC was first published last April so certainly sufficient time to get feedback.

The current cmdlets are on a path for native markdown support for help content and move away from MAML which requires the doc writers to convert from markdown to publish. Additional work in 6.2 timeframe to have this work end-to-end.

The longer term plan is to decouple all modules from PS Core.

@Jaykul

This comment has been minimized.

Show comment
Hide comment
@Jaykul

Jaykul Aug 1, 2018

I would not be very concerned about stepping on other commands -- if these commands were available on the gallery for older versions (like PowerShell 6)

Jaykul commented Aug 1, 2018

I would not be very concerned about stepping on other commands -- if these commands were available on the gallery for older versions (like PowerShell 6)

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