mirror of
https://github.com/zdharma-continuum/zinit-annex-submods.git
synced 2024-11-21 12:08:00 +01:00
49 lines
1.4 KiB
Markdown
49 lines
1.4 KiB
Markdown
# zinit-annex-submods
|
|
|
|
An annex (i.e., an extension for [Zinit](https://github.com/zdharma-continuum/zinit) –
|
|
[more information](https://zdharma-continuum.github.io/zinit/wiki/Annexes/)) that allows Zinit to clone additional
|
|
submodules when installing a plugin or snippet. The submodules are then automatically updated on the `zinit update ...`
|
|
command.
|
|
|
|
|
|
|
|
## Installation
|
|
|
|
Load as a plugin that installs the annex within Zinit:
|
|
|
|
```zsh
|
|
zinit light zinit-zsh/zinit-annex-submods
|
|
```
|
|
|
|
After this, you can use the `submods` ice.
|
|
|
|
## Usage
|
|
|
|
### Syntax
|
|
|
|
```zsh
|
|
submods'{user}/{plugin} -> {output directory}'
|
|
```
|
|
|
|
### Example of the `submods` ice
|
|
|
|
```zsh
|
|
# Load the `zsh-autosuggestions' plugin via `autosuggestions' Prezto module
|
|
zinit ice svn submods'zsh-users/zsh-autosuggestions -> external'
|
|
zinit snippet PZTM::autosuggestions
|
|
```
|
|
|
|
### Example of the `submods` ice and `for` syntax
|
|
|
|
```zsh
|
|
# Load the `zsh-autosuggestions' plugin via `autosuggestions' Prezto module
|
|
zi submods'zsh-users/zsh-autosuggestions -> external' for PZTM::autosuggestions
|
|
|
|
# Load the`zsh-history-substring-search' plugin via Oh-My-Zsh `history-substring-search' plugin
|
|
zi submods"zsh-users/zsh-history-substring-search -> external" svn for OMZP::history-substring-search
|
|
|
|
# Load the`zsh-completions' plugin via Oh-My-Zsh `completion' lib
|
|
zi submods"zsh-users/zsh-completions -> external" for OMZL::completion.zsh
|
|
```
|
|
|
|
<!-- vim:set tw=85: -->
|