platyPS | Write PowerShell External Help in Markdown

by PowerShell C# Version: 0.14.2 License: MIT

X-Ray Key Features Code Snippets Community Discussions(3)Vulnerabilities Install Support

kandi X-RAY | platyPS Summary

platyPS is a C# library typically used in Utilities applications. platyPS has no bugs, it has no vulnerabilities, it has a Permissive License and it has low support. You can download it from GitHub.

PlatyPS provides a way to:. Markdown help docs can be generated from old external help files (also known as MAML-xml help), the command objects (reflection), or both. PlatyPS can also generate cab files for Update-Help.

Support

Quality

Security

License

Reuse

Support

platyPS has a low active ecosystem.

It has 663 star(s) with 151 fork(s). There are 46 watchers for this library.

It had no major release in the last 12 months.

There are 103 open issues and 272 have been closed. On average issues are closed in 686 days. There are 8 open pull requests and 0 closed requests.

It has a neutral sentiment in the developer community.

The latest version of platyPS is 0.14.2

Quality

platyPS has 0 bugs and 0 code smells.

Security

platyPS has no vulnerabilities reported, and its dependent libraries have no vulnerabilities reported.

platyPS code analysis shows 0 unresolved vulnerabilities.

There are 0 security hotspots that need review.

License

platyPS is licensed under the MIT License. This license is Permissive.

Permissive licenses have the least restrictions, and you can use them in most projects.

Reuse

platyPS releases are available to install and integrate.

Installation instructions, examples and code snippets are available.

platyPS saves you 203 person hours of effort in developing the same functionality from scratch.

It has 499 lines of code, 0 functions and 82 files.

It has low code complexity. Code complexity directly impacts maintainability of the code.

Top functions reviewed by kandi - BETA

kandi's functional review helps you automatically verify the functionalities of the libraries and avoid rework.
Currently covering the most popular Java, JavaScript and Python libraries. See a Sample of platyPS

Get all kandi verified functions for this library.

platyPS Key Features

No Key Features are available at this moment for platyPS.

platyPS Examples and Code Snippets

No Code Snippets are available at this moment for platyPS.

Community Discussions

Trending Discussions on platyPS

Get-Help is not seeing the MAML help files when used against commands in my module

Powershell Copy-Item -recurse does not pick up new directory

Trouble getting local Git Changes to push to remote branch

QUESTION

Get-Help is not seeing the MAML help files when used against commands in my module

Asked 2022-Feb-09 at 05:09

I've been trying to improve our PS documentation and started playing with PlatyPS. So far, it's been great, I have nice markdown docs now. I'm also able to generate MAML for use with CLI documentation from it and have been able to remove the doc-comment strings from my modules.

Unfortunately, when I import my module it's unable to see the MAML help files and Get-Help for my exported function is very barebones.

My understanding is that when packaging MAML within a module, they need to be placed as follows:

...

ANSWER

Answered 2022-Feb-09 at 05:09

As it turns out, I was hitting a problem when generating the MAML from the markdown source. I was following this guide to PlatyPS and New-ExternalHelp was not generating help for the commands I happened to be testing with.

These commands were not named with the Verb-Noun nomenclature, and the files shared a name with their matching function. I took one of the functions and gave it a Verb-Noun name instead and did the same with its corresponding .md file. With a pattern of Verb-Noun.md, New-ExternalHelp now generated the command's MAML and placed them inside of MyModuleName-help.xml.

However, this is not what I wanted. These particular functions are named like commands on purpose, and I do not want to follow the Verb-Noun nomenclature for them. An edge case, probably, but I did find a solution for this as well. After a bit of testing, only the command name in the source .md file for that command matters as far as MAML generation.

The filename needs to match the Verb-Noun.md pattern, but you can have the command called FunctionName inside and the help will generate correctly for the command FunctionName, not Verb-Noun. Now when I import the module, I get the correct help topic for the commands that were previously missing.

Now my .md file no longer matches the command name but that isn't the end of the world.

Source https://stackoverflow.com/questions/71041701

QUESTION

Powershell Copy-Item -recurse does not pick up new directory

Asked 2021-Feb-18 at 21:11

I'm creating a binary PS module with PlatyPS help. I have a local poor-man's deploy script like this (PS 5.1):

...

ANSWER

Answered 2021-Feb-18 at 21:11

Answering my own question. My confusion stems from the fact that

Source https://stackoverflow.com/questions/66233969

QUESTION

Trouble getting local Git Changes to push to remote branch

Asked 2020-Feb-05 at 13:05

I have a local Git repo linked to Azure Repos.I have a Master, Development and several feature branches. I want to push all of my changes to the development branch and then merge that to Master.

The issue is my git status keeps changing from "...up to date..." to "Your branch is ahead...". If I use git pull/git push, my git status says everything is good, but if I wait a few minutes, git status says my branch is ahead again. I'm not sure what I broke.

...

ANSWER

Answered 2020-Feb-04 at 15:08

Have you tried something explicit like git push origin development:development to ensure your local development branch is pushed to origin/development ?

EDIT (04/02/2020) : See my comment below also about using development and Development as two of your branch names

Source https://stackoverflow.com/questions/60047725

Community Discussions, Code Snippets contain sources that include Stack Exchange Network

Vulnerabilities

No vulnerabilities reported

Install platyPS

Edit markdown files in .\docs folder and populate {{ ... }} placeholders with missed help content. Create external help from markdown help.
Install platyPS module from the PowerShell Gallery:
Create initial Markdown help for MyAwesomeModule module:
Edit markdown files in .\docs folder and populate {{ ... }} placeholders with missed help content.
Create external help from markdown help
Congratulations, your help is now in markdown!
Now, if your module code changes, you can easily update your markdown help with
For information about building from sources and contributing see contributing guidelines.

Support

For any new features, suggestions and bugs create an issue on GitHub. If you have any questions check and ask questions on community page Stack Overflow .

Find more information at: