mj / zsh-config

Download as
Browse Code ยป

Commit fb91d6087105bf8bc996c33e8417adfc26f39266

Authored by Shrikant Sharat
1 parent 0c257ebe4a

Update docs on the new `-theme` sweetness. Fix #29.

Showing 1 changed file with 16 additions and 2 deletions Side-by-side Diff

... ... @@ -371,8 +371,19 @@ want to use.
371 371  
372 372 antigen-theme fox
373 373  
374   -Currently, themes are pulled from robbyrussell's oh-my-zsh repo, but it will
375   -support getting themes from other repos as well in the future.
  374 +This will get the theme file located at `themes/fox.zsh-theme` in the repo
  375 +specified by `ANTIGEN_DEFAULT_REPO_URL`.
  376 +
  377 +To pull themes from other repositories, use `antigen-theme` just like
  378 +`antigen-bundle`. Exactly the same, just make sure the `url` and `loc`
  379 +combination point to a theme file, having a `.zsh-theme` extension.
  380 +
  381 +For example,
  382 +
  383 + antigen-theme robbyrussell/oh-my-zsh themes/apple
  384 +
  385 +Will pull the apple theme from the canonical oh-my-zsh repo. Also, note that the
  386 +`.zsh-theme` extension is not present. It can be given, its optional.
376 387  
377 388 You can use this command to change your theme on the fly in your shell. Go on,
378 389 try out a few themes in your shell before you set it in your `.zshrc`.
... ... @@ -381,6 +392,9 @@ try out a few themes in your shell before you set it in your `.zshrc`.
381 392 avoid any trouble, run `antigen-lib` if you haven't already before experimenting
382 393 with themes. If you have `antigen-lib` in your `.zshrc`, you're covered.
383 394  
  395 +**Note**: Do *not* provide the `--btype` argument to `antigen-theme`. Its an
  396 +internal argument.
  397 +
384 398 ### antigen-apply
385 399  
386 400 You have to add this command after defining all bundles you need, in your zshrc.