mirror of
https://github.com/zplug/zplug
synced 2024-06-03 13:26:10 +02:00
Update docs
This commit is contained in:
parent
6334db67ee
commit
c7f10b0ad5
|
@ -166,6 +166,9 @@ zplug "zsh-users/zsh-syntax-highlighting", nice:10
|
|||
# Can manage local plugins
|
||||
zplug "~/.zsh", from:local
|
||||
|
||||
# Load theme file
|
||||
zplug 'dracula/zsh', as:theme
|
||||
|
||||
# Install plugins if there are plugins that have not been installed
|
||||
if ! zplug check --verbose; then
|
||||
printf "Install? [y/N]: "
|
||||
|
@ -247,7 +250,7 @@ All that's left is to run `zplug update`.
|
|||
|
||||
| Tag | Description | Value (default) | Example |
|
||||
|-----|-------------|-----------------|---------|
|
||||
| `as` | Specify whether to register the package as plugins or commands | `plugin`,`command` (`plugin`) | `as:command` |
|
||||
| `as` | Specify whether to register the package as plugins or commands | `plugin`,`command`,`theme` (`plugin`) | `as:command` |
|
||||
| `use` | Specify the pattern of the files to source (for `plugin`) or the relative path to add to the `$PATH` (for `command`) / With `from:gh-r`, zplug tries to guess which file to use from your OS and architecture. You can manually specify `use:"*darwin*{amd,386}*"` if that doesn't get the right file. | *glob* (`use:"*.zsh"`) | `use:bin`,`use:"*.sh"`, `use:*darwin*` |
|
||||
| `ignore` | Similar to `use` tag, but specify pattern of files you want to ignore (see also [#56](https://github.com/zplug/zplug/issues/56)) | *glob* (-) | `ignore:"some_*.zsh"` |
|
||||
| `from` | Specify where to get the package from | `github`,`bitbucket`,<br>`gh-r`,`gist`,<br>`oh-my-zsh`,`prezto`,`local` (`github`) | `from:gh-r` |
|
||||
|
|
|
@ -168,6 +168,9 @@ zplug "zsh-users/zsh-syntax-highlighting", nice:10
|
|||
# ローカルプラグインも読み込める
|
||||
zplug "~/.zsh", from:local
|
||||
|
||||
# テーマファイルを読み込む
|
||||
zplug 'dracula/zsh', as:theme
|
||||
|
||||
# 未インストール項目をインストールする
|
||||
if ! zplug check --verbose; then
|
||||
printf "Install? [y/N]: "
|
||||
|
@ -249,7 +252,7 @@ zplug "zplug/zplug"
|
|||
|
||||
| タグ | 説明 | 値 (デフォルト値) | 例 |
|
||||
|-----|-------------|-----------------|---------|
|
||||
| `as` | プラグインとして、またはコマンドとして追加するか指定する | `plugin`,`command` (`plugin`) | `as:command` |
|
||||
| `as` | プラグインとして、またはコマンドとして追加するか指定する | `plugin`,`command`,`theme` (`plugin`) | `as:command` |
|
||||
| `use` | 読み込むファイルパターンを指定する (`plugin` のとき) か `$PATH` に追加したいコマンドの相対パスを指定する (`command` のとき) / `from:gh-r` の場合は zplug が自動で OS のアーキテクチャを判別するが、意図しない結果の場合 `use:"*darwin*{amd,386}*"` のようにすると良い | *グロブ・パターン* (`use:"*.zsh"`) | `use:bin`,`use:"*.sh"`, `use:*darwin*` |
|
||||
| `ignore` | `use` タグと似ているが無視したいファイルパターンを指定する ([#56](https://github.com/zplug/zplug/issues/56) 参照) | *グロブ・パターン* (-) | `ignore:"some_*.zsh"` |
|
||||
| `from` | どこからインストールするか指定する | `github`,`bitbucket`,<br>`gh-r`,`gist`,<br>`oh-my-zsh`,`prezto`,`local` (`github`) | `from:gh-r` |
|
||||
|
|
|
@ -23,10 +23,10 @@ will be installed as the plugin or as the command.
|
|||
|
||||
.zplug as tag
|
||||
[options="header"]
|
||||
|================================
|
||||
| Possive Values | Default value
|
||||
| plugin, command | plugin
|
||||
|================================
|
||||
|=======================================
|
||||
| Possive Values | Default value
|
||||
| plugin, command, theme | plugin
|
||||
|=======================================
|
||||
|
||||
Besides, by using `zstyle` command, you can change default value:
|
||||
|
||||
|
@ -54,6 +54,14 @@ $ zplug "stedolan/jq" \
|
|||
use:"*darwin*"
|
||||
------------
|
||||
|
||||
As a theme:
|
||||
|
||||
------------
|
||||
$ zplug 'themes/apple', \
|
||||
as:theme, \
|
||||
from:oh-my-zsh
|
||||
------------
|
||||
|
||||
|
||||
SEE ALSO
|
||||
--------
|
||||
|
|
|
@ -113,7 +113,7 @@ Values 'truthy' and 'falsy' mean any of "true, yes, on, 1" and "false, no, off,
|
|||
|Tag |Description |Value (default) |Example
|
||||
|
||||
|*as* | Whether to register the package as commands or as plugins
|
||||
| `plugin`,`command` (`plugin`) | `as:command`
|
||||
| `plugin`,`command`,`theme` (`plugin`) | `as:command`
|
||||
|
||||
|*use* | Specify the pattern of the files to source (for `plugin`) or the relative path
|
||||
from the package root of the file to add to `$PATH` (for `command`) / Useful,
|
||||
|
@ -307,7 +307,7 @@ zplug "junegunn/fzf-bin", \
|
|||
|
||||
# Support oh-my-zsh plugins and the like
|
||||
zplug "plugins/git", from:oh-my-zsh, if:"(( $+commands[git] ))"
|
||||
zplug "themes/duellj", from:oh-my-zsh
|
||||
zplug "themes/duellj", from:oh-my-zsh, as:theme
|
||||
zplug "lib/clipboard", from:oh-my-zsh, if:"[[ $OSTYPE == *darwin* ]]"
|
||||
|
||||
# Also supports prezto plugins
|
||||
|
@ -354,6 +354,9 @@ zplug "zsh-users/zsh-syntax-highlighting", nice:10
|
|||
# Can manage local plugins
|
||||
zplug "~/.zsh", from:local
|
||||
|
||||
# Load theme file
|
||||
zplug 'dracula/zsh', as:theme
|
||||
|
||||
# Install plugins if there are plugins that have not been installed
|
||||
if ! zplug check --verbose; then
|
||||
printf "Install? [y/N]: "
|
||||
|
|
Loading…
Reference in New Issue