-
Notifications
You must be signed in to change notification settings - Fork 10
New‑GitHubWikiSidebar
Creates a GitHub Wiki sidebar based on existing markdown files and their metadata.
New-GitHubWikiSidebar [-DocumentationPath] <String> [[-OutputPath] <String>] [[-SidebarFileName] <String>]
[-ReplaceExisting] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
This command creates a new GitHub wiki sidebar file with the specified output path and sidebar file name. The sidebar is created based on existing markdown files and their metadata
New-GitHubWikiSidebar -OutputPath 'C:\Wiki' -SidebarFileName 'CustomSidebar.md'
Creates a new GitHub wiki sidebar file named 'CustomSidebar.md' in the 'C:\Wiki' directory.
New-GitHubWikiSidebar -DocumentationPath './output/WikiOutput' -Force
Creates a GitHub Wiki sidebar using default path and filename. The sidebar will be created even if it already exists.
Specifies the FileInfo object of the markdown file containing the documentation being edited. This parameter is mandatory.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies that the sidebar should be created without any confirmation.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the output path where the sidebar file will be created.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies whether to force the creation of the sidebar even if it already exists. By default, if the sidebar file already exists, the function will not overwrite it.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the name of the sidebar file. The default value is '_Sidebar.md'.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: _Sidebar.md
Accept pipeline input: False
Accept wildcard characters: FalsePrompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseShows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.