Skip to content

Get MarkdownHelp

James Brundage edited this page Apr 22, 2022 · 7 revisions

Get-MarkdownHelp

Synopsis

Gets Markdown Help


Description

Gets Help for a given command, in Markdown


Related Links


Examples

EXAMPLE 1

Get-MarkdownHelp Get-Help

Parameters

Name

The name of the specified command or concept.

Type Requried Postion PipelineInput
[String] false 1 true (ByPropertyName)

Wiki

If set, will generate a markdown wiki. Links will be relative to the current path, and will not include the .md extensions

Type Requried Postion PipelineInput
[Switch] false named false

GitHubDocRoot

If set, will interlink documentation as if it were for GitHub pages, beneath a given directory

Type Requried Postion PipelineInput
[String] false named false

Outputs

[string]

The documentation for a single command, in Markdown.


Syntax

Get-MarkdownHelp [[-Name] <String>] [-Wiki] [-GitHubDocRoot <String>] [<CommonParameters>]

Testing if custom sidebar overrides automatic

Clone this wiki locally