Comments (7)
Not needed, per #51
from platyps.
i agree with this. I use these when i make my MD docs
#Synopsis
{{ Synopsis here }}
---
#Description
{{ Description here }}
---
#Examples
etc etc etc
i think it gives it a little structure when the markdown is rendered.
- examples here
from platyps.
Agreed. The lines are useful between sections.
EDIT: The rest doesn't apply. RE: one cmdlet per md file decision.
However, if we do use them inter-section, we will need something additional between cmdlets.
{Cmdlet 1 Section A}
{Cmdlet 1 Section B}
Maybe a double line for simplicity?
{Cmdlet 1 Content}
{Cmdlet 2 Content}
from platyps.
I thought each cmdlet was in its own markdown file, so there should only be one command per file? or am i missing something?
from platyps.
you know what, your right. I'm thinking of schema 1.0. It's 7am here, apologies.....
from platyps.
LOL no worries.
from platyps.
closing old issues
from platyps.
Related Issues (20)
- Support for Default Command Prefix
- Where can I find schema for `*-help.xml`? HOT 1
- PlatyPs fails to load alongside powershell-yaml HOT 2
- PlatyPS needs to support the new ProgressAction common parameter HOT 21
- NodeModelToMamlModel\ failing with two examples in Markdown file HOT 3
- CommonParameters should not be overwritten when newlines are introduced HOT 1
- Syntax code fence should have language specified HOT 1
- Headers should have blank line MD22 HOT 1
- New markdown help generates extra new line MD12 HOT 1
- Unsafe characters in command names breaks markdown file creation on Windows HOT 2
- A way to suppress parameter types HOT 2
- 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 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
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.