Add-GitBookPlugin

SYNOPSIS

Add a gitbook plugin to the project's documentation config

SYNTAX

Add-GitBookPlugin [[-PluginName] <String[]>] [[-ConfigurationFilePath] <String>] [<CommonParameters>]

DESCRIPTION

Add a gitbook plugin to the project's documentation configuration. You can specify a '-' at the beginning of the plugin name to remove a built-in plugin.

EXAMPLES

EXAMPLE 1

Add-GitBookPlugin -PluginName code

Adds the code plugin to the default GitBook config in the project.

EXAMPLE 2

'code', 'code-captions' | Add-GitBookPlugin

Adds the code and code-captions plugins to the default GitBook config in the project, showing passing plugins by the pipeline.

EXAMPLE 3

Add-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 added to the config file. This function does not verify whether or not the plugin is valid or discoverable.

If you specify a '-' at the beginning of the plugin name for a default plugin it will instead remove that plugin from the load order. This only works for built-in plugins.

Note that this command does not modify the pluginConfig setting where individual plugins are configured. It adds the plugin to the load list and will therefore get the plugin's default config.

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 added.

OUTPUTS

String

JSON string representation of the GitBook config after updating.

NOTES

Alias: agbp

results matching ""

    No results matching ""