Skip to content

Document pre/post options #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
xuhdev wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document pre/post options #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 21 additions & 1 deletion _sections/06-options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ zsh-defer source /Users/matt/Library/Caches/antidote/https-COLON--SLASH--SLASH-g

## Branch

You can also specify a branch to download, if you don't want the `main` branch for
You can also specify a branch to download, if you don't want the default branch for
whatever reason.

Example:
Expand Down Expand Up @@ -116,6 +116,26 @@ fpath+=( /Users/matt/Library/Caches/antidote/https-COLON--SLASH--SLASH-github.co
source /Users/matt/Library/Caches/antidote/https-COLON--SLASH--SLASH-github.com-SLASH-ohmyzsh-SLASH-ohmyzsh/plugins/magic-enter/magic-enter.plugin.zsh
```

## Pre/Post

You may specify a function that runs before/after loading the plugin. They can
be used to configure the plugin.

Example:

```console
$ antidote bundle zsh-users/zsh-autosuggestions post:adjust_autosuggestions_style
```

with `adjust_autosuggestions_style` being a function defined before `antidote
load` is called:

```console
function adjust_autosuggestions_style () {
ZSH_AUTOSUGGEST_HIGHLIGHT_STYLE='fg=244'
}
```

## Friendly Names

You can also change how Antidote names the plugin directories by adding this to your
Expand Down