diff --git a/plugins/bridgetown/README.md b/plugins/bridgetown/README.md index 0a41814ee..7f8a8eab5 100644 --- a/plugins/bridgetown/README.md +++ b/plugins/bridgetown/README.md @@ -1,6 +1,6 @@ # Bridgetown plugin -This plugin adds some aliases and autocompletion for common [Bridgetown](https://bridgetownrb.com/) commands. +This plugin adds aliases for common [Bridgetown](https://www.bridgetownrb.com/) commands. To use it, add `bridgetown` to the plugins array in your zshrc file: @@ -10,17 +10,27 @@ plugins=(... bridgetown) ## Aliases -| Alias | Command | -|-------|----------------------------| -| br | `bridgetown` | -| bra | `bin/bridgetown apply` | -| brb | `bin/bridgetown build` | -| brc | `bin/bridgetown console` | -| brclean | `bin/bridgetown clean` | -| brd | `bin/bridgetown deploy` | -| brdoc | `bin/bridgetown doctor` | -| brh | `bin/bridgetown help` | -| brn | `bridgetown new` | -| brp | `bridgetown plugins` | -| brpl | `bridgetown plugins list` | -| brs | `bin/bridgetown start` | +Most aliases use the project's `bin/bridgetown` executable so the command runs with the Bridgetown version +locked in its `Gemfile`. The `br` and `brn` aliases use the globally installed executable and can be run +outside a Bridgetown project. + +| Alias | Command | Description | +| --------- | ---------------------------- | ---------------------------------------- | +| `br` | `bridgetown` | Run the globally installed CLI | +| `bra` | `bin/bridgetown apply` | Apply an automation | +| `brb` | `bin/bridgetown build` | Build the site | +| `brc` | `bin/bridgetown console` | Open the Bridgetown console | +| `brclean` | `bin/bridgetown clean` | Remove generated files and caches | +| `brco` | `bin/bridgetown configure` | Apply a bundled configuration | +| `brd` | `bin/bridgetown deploy` | Run the project's deployment task | +| `brdev` | `bin/bridgetown dev` | Start the development server | +| `bre` | `bin/bridgetown esbuild` | Manage the esbuild configuration | +| `brh` | `bin/bridgetown help` | Show command help | +| `brn` | `bridgetown new` | Create a new Bridgetown site | +| `brp` | `bin/bridgetown plugins` | Access plugin commands | +| `brpl` | `bin/bridgetown plugins list` | List installed plugins | +| `brs` | `bin/bridgetown start` | Start the development server | +| `brt` | `bin/bridgetown test` | Run the project's test build task | + +`deploy` and `test` are standard tasks from the `Rakefile` generated for a new Bridgetown site. If the project +customizes or removes those tasks, the corresponding aliases follow that project behavior. diff --git a/plugins/bridgetown/bridgetown.plugin.zsh b/plugins/bridgetown/bridgetown.plugin.zsh index 502e9dfe0..2228bb744 100644 --- a/plugins/bridgetown/bridgetown.plugin.zsh +++ b/plugins/bridgetown/bridgetown.plugin.zsh @@ -3,10 +3,13 @@ alias bra='bin/bridgetown apply' alias brb='bin/bridgetown build' alias brc='bin/bridgetown console' alias brclean='bin/bridgetown clean' +alias brco='bin/bridgetown configure' alias brd='bin/bridgetown deploy' -alias brdoc='bin/bridgetown doctor' +alias brdev='bin/bridgetown dev' +alias bre='bin/bridgetown esbuild' alias brh='bin/bridgetown help' alias brn='bridgetown new' -alias brp='bridgetown plugins' -alias brpl='bridgetown plugins list' +alias brp='bin/bridgetown plugins' +alias brpl='bin/bridgetown plugins list' alias brs='bin/bridgetown start' +alias brt='bin/bridgetown test'