Comments (3)
I see, thank you!
I think it's a reasonable request.
from platyps.
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:
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?
from platyps.
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...
from platyps.
Related Issues (20)
- New-ExternalHelp should be able to create MAML from markdown that uses the new schema HOT 1
- New-YamlHelp needs to convert the module.md file to YAML HOT 1
- Unable to detect markdown file HOT 1
- New-MarkdownHelp provides unclear error when module as no commands
- Support for data from XMLdoc for binary modules HOT 2
- Parameter Sets with 0.14.2 HOT 1
- 🚀 [Idea]: Support adding titles to examples HOT 1
- Create new cmdlets for creating Cab/Zip files for updateable help
- After updating version of platyPS (from ) creating new external help file is throwing error
- HelpVersion parameter support
- Update-MarkdownCommandHelp should have the ability to skip update of module markdown file
- Export-YamlCommandHelp should create module folder structure
- Support module files with multiple H2 for grouping cmdlets
- Protect certain frontmatter metadata fields
- Support unordered list of links under RELATED LINKS
- [V2 test] New-MarkdownCommandHelp incorrect metadata in module file
- [V2 test] New-MarkdownCommandHelp not honoring -HelpUri and -HelpInfoUri
- [V2 test] PS> Import-MarkdownModuleFile need to transform "Download Help Link"
- [New-ExternalHelp] Generate incorrect MAML file if example includes []
- Supress ProgressAction parameter from New-MarkdownHelp output HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from platyps.