Suggestion for generated markdown header

[squid808]

Hello! This tool looks great, and I plan to use this to help automate my github wiki very soon! However, I see in the newest version (from the repo, not from the PoSh Gallery) that the New-Markdown shows a header, even on your pages. For instance:

---
external help file: gShell.dll-Help.xml
schema: 2.0.0

---

At the very least can this be moved to the bottom and/or become optional with a switch like you'd see with Export-Csv -NoTypeInformation?

I'm hip deep in things at the moment, but I can look in to making a pull request sometime this week if that would make things any faster.

Thanks for your consideration!

[vors]

Glad to hear you like the project!
We are preparing release 0.4.0 with support for schema 2.0.0 and new cmdlets, stay tuned.

Yaml header format is not a part of common mark spec (which we are trying to follow), but it's widely used by different tools:

• Octopress
• PowerShell-Docs
• R markdown

It's always located at the top of the page.
GitHub renders it as a table and it would not render it properly, if it's not located at the top.

Without using it, user would need to pass such metadata (i.e. schema version) from command line. Although, C# part has this API, I didn't expose it via cmdlet.
Can you, elaborate, why you don't want to have it?

[squid808]

Interesting, I hadn't run in to it before and therefore hadn't realized it was more than just an informational header - thanks for that info.

As to why I'm requesting, I am a poor soul who is only able to host my files here on github. My goal is to allow my project wikis to be my online documentation (tied in with my Get-Help My-Cmdlet -online target uri), one page per Cmdlet similar to what we'd see in TechNet. I'd like to provide my users a clean viewing experience, and since I doubt that any secondary tool will be processing these files I see no need to have the header in my wiki files.

With that said, I realized that it must serve some purpose since it's there (and on) by default. So if it were optional I think it'd make sense to leave it on by default, but to have a SwitchParameter to allow it to be disabled for fringe cases like mine.

_{Also, slightly off topic - if there was a promotional switch to add some kind of 'This document generated with PlatyPS' I'd use that too...}

[vors]

I see, thank you!
I think it's a reasonable request.