Skip to content

Invoke-GitLabProjectDocumentation

SYNOPSIS

Generate documentation for the GitLab project using PlatyPS.

SYNTAX

Invoke-GitLabProjectDocumentation [[-OutputPath] <String>]

DESCRIPTION

This function generates documentation for the GitLab project using PlatyPS. It creates markdown files for each function in the module and organizes them into a structured format suitable for MkDocs.

EXAMPLES

EXAMPLE 1

Invoke-GitLabProjectDocumentation

Generates markdown files for the current GitLab project using the default output path `mkdocs`.

EXAMPLE 2

Invoke-GitLabProjectDocumentation -OutputPath 'docs'

Generates markdown files for the current GitLab project and saves them in the `docs` folder.

PARAMETERS

-OutputPath

The path where the generated markdown files will be saved. Default is `mkdocs`. If the path does not exist, it will be created.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: Docs
Accept pipeline input: False
Accept wildcard characters: False

INPUTS

OUTPUTS

NOTES