Remove-GitBookPlugin
SYNOPSIS
Remove a gitbook plugin to the project's documentation config
SYNTAX
Remove-GitBookPlugin [[-PluginName] <String[]>] [[-ConfigurationFilePath] <String>] [<CommonParameters>]
DESCRIPTION
Remove a gitbook plugin to the project's documentation configuration.
EXAMPLES
EXAMPLE 1
Remove-GitBookPlugin -PluginName code
Removes the code plugin from the default GitBook config in the project.
EXAMPLE 2
'code', 'code-captions' | Remove-GitBookPlugin
Removes the code and code-captions plugins from the default GitBook config in the project, showing passing plugins by the pipeline.
EXAMPLE 3
Remove-GitBookPlugin -PluginName code -ConfigurationFilePath ./example/book.json
PARAMETERS
-ConfigurationFilePath
The path to the GitBook configuration file. Will search for the file in the default locations if not specified.
Type: String
Parameter Sets: (All)
Aliases: Path, FilePath, Config
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-PluginName
The name(s) of the plugin(s) to be removed from the config file. This function does not verify whether or not the plugin is valid or discoverable.
Note that this command does modify the pluginConfig setting where individual plugins are configured. It removes the plugin to the load list and from the pluginConfig both.
Type: String[]
Parameter Sets: (All)
Aliases: Name, Plugin
Required: False
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
String{}
One or more strings representing the plugins to be removed.
OUTPUTS
String
JSON string representation of the GitBook config after updating.
NOTES
Alias: rgbp