New MarkdownDoc - PPOSHGROUP/PPoShTools GitHub Wiki

New-MarkdownDoc

PPoShTools -> New-MarkdownDoc.ps1

Synopsis

Generates markdown documentation for each public function from given module.

Syntax

New-MarkdownDoc -ModulePath <String> -OutputPath <String> [-GitBaseUrl 
<String>] [<CommonParameters>]

New-MarkdownDoc -DirectoryPath <String> -OutputPath <String> [-GitBaseUrl 
<String>] [<CommonParameters>]

Parameters

-ModulePath<String>

Module to scan.

  • PipelineInput: false
  • Required: true

-DirectoryPath<String>

  • PipelineInput: false
  • Required: true

-OutputPath<String>

Base output path.

  • PipelineInput: false
  • Required: true

-GitBaseUrl<String>

Base Git url to generate links to source files.

  • PipelineInput: false
  • Required: false

Examples

Example 1

New-MarkdownDoc -ModuleName 'PSCI' -OutputPath '..\PSCI.wiki\api' -GitBaseUrl 'https://github.com/ObjectivityBSS/PSCI/tree/master'
⚠️ **GitHub.com Fallback** ⚠️