zinit-annex-submods/README.md

zinit-annex-submods

An annex (i.e., an extension for Zinit – more information) 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:

zinit light zinit-zsh/zinit-annex-submods

After this, you can use the submods ice.

Usage

Syntax

submods'{user}/{plugin} -> {output directory}'

Example of the submods ice

# 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

# 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