< Back
New-DocusaurusHelp
Post
NAME New-DocusaurusHelp
SYNOPSIS
Generates Get-Help documentation in Docusaurus compatible `.mdx` format.
SYNTAX
New-DocusaurusHelp [-Module] <String> [[-OutputFolder] <String>] [[-Sidebar] <String>] [-EditUrl] <String>
[-Monolithic] [<CommonParameters>]
DESCRIPTION
The `New-DocusaurusHelp` cmdlet generates Get-Help documentation in Docusaurus
compatible format by creating an `.mdx` file for each command exported by
the module, enriched with command-specific front matter variables.
Also creates a `sidebar.js` file for simplified integration into the Docusaurus sidebar menu.
PARAMETERS
-Module <String>
Specifies the module this cmdlet will generate Docusaurus documentation for.
You may specify a module name, a `.psd1` file or a `.psm1` file.
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-OutputFolder <String>
Specifies the folder where the Docusaurus sidebar subfolder will be created.
Optional, defaults to `docusaurus/docs`, case sensitive.
Required? false
Position? 2
Default value docusaurus/docs
Accept pipeline input? false
Accept wildcard characters? false
-Sidebar <String>
Specifies the subfolder where the Get-Help `.mdx` files for the module will be created.
Optional, defaults to `CmdLets`, case sensitive.
Required? false
Position? 3
Default value CmdLets
Accept pipeline input? false
Accept wildcard characters? false
-EditUrl <String>
Specifies the URL prefixed to all Docusaurus `custom_edit_url` front matter variables.
Required? true
Position? 4
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Monolithic [<SwitchParameter>]
Use this optional argument if the Powershell module source is monolithic.
Will point all `custom_edit_url` front matter variables to the `.psm1` file.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
System.Object
NOTES
Please note that Docusaurus v2 is an early and alpha version, just like this module.
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>New-DocusaurusHelp -Module Alt3.Docusaurus.Powershell -EditUrl
"https://github.com/alt3/Docusaurus.Powe ... rce/Public"
RELATED LINKS
https://v2.docusaurus.io/
https://github.com/PowerShell/platyPS
SYNOPSIS
Generates Get-Help documentation in Docusaurus compatible `.mdx` format.
SYNTAX
New-DocusaurusHelp [-Module] <String> [[-OutputFolder] <String>] [[-Sidebar] <String>] [-EditUrl] <String>
[-Monolithic] [<CommonParameters>]
DESCRIPTION
The `New-DocusaurusHelp` cmdlet generates Get-Help documentation in Docusaurus
compatible format by creating an `.mdx` file for each command exported by
the module, enriched with command-specific front matter variables.
Also creates a `sidebar.js` file for simplified integration into the Docusaurus sidebar menu.
PARAMETERS
-Module <String>
Specifies the module this cmdlet will generate Docusaurus documentation for.
You may specify a module name, a `.psd1` file or a `.psm1` file.
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-OutputFolder <String>
Specifies the folder where the Docusaurus sidebar subfolder will be created.
Optional, defaults to `docusaurus/docs`, case sensitive.
Required? false
Position? 2
Default value docusaurus/docs
Accept pipeline input? false
Accept wildcard characters? false
-Sidebar <String>
Specifies the subfolder where the Get-Help `.mdx` files for the module will be created.
Optional, defaults to `CmdLets`, case sensitive.
Required? false
Position? 3
Default value CmdLets
Accept pipeline input? false
Accept wildcard characters? false
-EditUrl <String>
Specifies the URL prefixed to all Docusaurus `custom_edit_url` front matter variables.
Required? true
Position? 4
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Monolithic [<SwitchParameter>]
Use this optional argument if the Powershell module source is monolithic.
Will point all `custom_edit_url` front matter variables to the `.psm1` file.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
System.Object
NOTES
Please note that Docusaurus v2 is an early and alpha version, just like this module.
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>New-DocusaurusHelp -Module Alt3.Docusaurus.Powershell -EditUrl
"https://github.com/alt3/Docusaurus.Powe ... rce/Public"
RELATED LINKS
https://v2.docusaurus.io/
https://github.com/PowerShell/platyPS