Comments (3)
Idea for how to accomplish this. @vors please validate my thoughts if you have time. @sankethka for awareness....
We need to have the ability to generate a landing page as part of the new-markdown functionality. This would only be triggered when you create an entire module.
This suggestion only covers the initially creation, after we have that, we should discuss the update scenario for Update-Markdown.
Using each of the cmdlets names (which become CmdletName.md), the Module Guid, and the Module Name, we create a MD file named ModuleName.md with the following
Metadata:
Module Name: {Populated during New-Markdown}
Module Guid:{Populated during New-Markdown}
Download Help Link: {{Please enter FwLink manually}}
Help Version: {{Please enter version of help manually (X.X.X.X) format}}
Locale: {{Please enter help locale code manually (xx-XX) format}}
{Module Name} Module
Description
{{Manually Enter Description Here}}
{Module Cmdlets} Cmdlets
{CmdletName.md Link}}
{{Manually Enter Description Here}}
{Cmdlet Name.md Link}}
{{Manually Enter Description Here}}
from platyps.
Checked in to master:
New-Markdown with -Module or -Maml creates a landing pages.
Remaining:
Create Help Cab using metadata info from Landing page
from platyps.
Finalizing tests, but this is complete.
from platyps.
Related Issues (20)
- Update-MarkdownHelpModule: Unable to write content because it is a directory HOT 1
- 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
- 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 []
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.