platyPS icon indicating copy to clipboard operation
platyPS copied to clipboard

Provide Related Links template

Open jdhitsolutions opened this issue 8 years ago • 1 comments

Since many people using this module may be new to markdown, the module needs to be a bit more forgiving. I'd put myself in this category as well. Most IT Pros who are used to creating comment based help are familiar with simply listing a cmdlet name under Links.

But in the generated MD file if you try to use something like this:

## RELATED LINKS
Get-Credential
ConvertFrom-SecureString

You get an error when exporting to external help. It took me a while to stare at the error message long enough to realize I needed to enter the links like this:

## RELATED LINKS
[Get-Credential]()
[ConvertFrom-SecureString]()

I'd suggest either having code that is more forgiving of the latter or insert a template under RELATED LINKS to indicate the proper form.

jdhitsolutions avatar Dec 24 '16 16:12 jdhitsolutions

Yes, definitely. It's a great suggestion, I think the current behavior is silently ignore any text that is not a link under related links.

vors avatar May 15 '17 06:05 vors

It would also be great to update the expected Markdown schema for related links to:

## RELATED LINKS
* [My-Cmdlet](./my-cmdlet.md)
* [My-OtherCmdlet](./my-othercmdlet.md)

so that when this is viewed as HTML, you get a nice bulleted list. Currently, because the list of related links is un-bulleted, it's renederd in HTML as

My-Cmdlet My-OtherCmdlet

because newlines and whatnot are stripped out and replaced with a single space character.

When converting to MAML, of course, the leading bullet (* or -) will need to be stripped off, but that should be a minor parsing detail.

fourpastmidnight avatar Apr 23 '24 15:04 fourpastmidnight

This is fixed in platyps 0.14

sdwheeler avatar May 31 '24 17:05 sdwheeler