mj / zsh-config

Download as
Browse Code ยป

Commit ac6ddd7d483b83e37b4a21d162b2789d551e8af8

Authored by Shrikant Sharat
1 parent b36de9bb3d

Heading levels + 1.

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

... ... @@ -9,7 +9,7 @@ incompatible changes now and then, until we have a pretty stable system we can
9 9 reason about. **Please** read the commit comments of the changesets when you
10 10 pull a new version of antigen.
11 11  
12   -# Show off
  12 +## Show off
13 13  
14 14 > Enough talk. Let's fight!
15 15 > -- Po, Kung-fu Panda.
... ... @@ -63,7 +63,7 @@ library of oh-my-zsh loaded. So, if you want to experiment further, issue a
63 63 and continue until you're tired. At which point you can come back to this page
64 64 ;)
65 65  
66   -# Usage
  66 +## Usage
67 67  
68 68 So, now that you're here, I'll assume you are convinced and want antigen running
69 69 your shell all the time. Sweet. Let's do it.
... ... @@ -101,7 +101,7 @@ Open your zsh with this zshrc and you should see all the bundles you defined
101 101 here, getting installed. Once its done, you are ready to roll. The complete
102 102 syntax for the `antigen-bundle` command is discussed further down on this page.
103 103  
104   -# Motivation
  104 +## Motivation
105 105  
106 106 If you use zsh and [oh-my-zsh][], you know that having many different plugins
107 107 that are developed by many different authors in a single (sub)repo is not a very
... ... @@ -130,9 +130,9 @@ Antigen also lets you switch the prompt theme with one command, just like that
130 130  
131 131 and your prompt is changed, just for this session of course.
132 132  
133   -# Commands
  133 +## Commands
134 134  
135   -## antigen-bundle
  135 +### antigen-bundle
136 136  
137 137 This command tells antigen to install (if not already installed) and load the
138 138 given plugin. The simplest usage follows the following syntax.
... ... @@ -196,7 +196,7 @@ from your shell environment. This allows you to install plugins on the fly and
196 196 try them out. Of course if you want a bundle to be available every time you open
197 197 a shell, put it in your `.zshrc`.
198 198  
199   -## antigen-bundles
  199 +### antigen-bundles
200 200  
201 201 If you have a fair number of bundles, using the `antigen-bundle` command can
202 202 look cumbersome. You can use the `antigen-bundles` command to *bulk* define
... ... @@ -227,7 +227,7 @@ lines and those starting with a `#` are ignored. The rest are passed to
227 227 with the `antigen-bundle` command. See the source if you want to really
228 228 understand how it works. Its a very small function.
229 229  
230   -## antigen-update
  230 +### antigen-update
231 231  
232 232 This is something you might not want to put in your `.zshrc`. Instead, run it
233 233 occasionally to update all your plugins. It doesn't take any arguments.
... ... @@ -243,7 +243,7 @@ real quirky.
243 243 **Please note**: This command is not for updating *antigen* itself. Its for
244 244 updating the bundles you are using with antigen.
245 245  
246   -## antigen-list
  246 +### antigen-list
247 247  
248 248 Use this command to list out the currently *loaded* plugins. Keep in mind that
249 249 this includes any bundles installed on-the-fly.
... ... @@ -251,7 +251,7 @@ this includes any bundles installed on-the-fly.
251 251 Takes no arguments. Gives out the repo url and the plugin's location under the
252 252 repo.
253 253  
254   -## antigen-cleanup
  254 +### antigen-cleanup
255 255  
256 256 Used to clean up the clones of repos which are not used by any plugins. It takes
257 257 no arguments. When this is run, it lists out the repo-clones that are available
... ... @@ -260,7 +260,7 @@ but are not used by any plugin *currently loaded*.
260 260 This command currently cannot run in a non-interactive mode. So it won't be very
261 261 pleasant to use it in your `.zshrc`.
262 262  
263   -## antigen-lib
  263 +### antigen-lib
264 264  
265 265 This is a shortcut to
266 266  
... ... @@ -282,7 +282,7 @@ Use
282 282 in your `.zshrc`, before any `antigen-bundle` declarations. It takes no
283 283 arguments.
284 284  
285   -## antigen-theme
  285 +### antigen-theme
286 286  
287 287 Used for switching the prompt theme. Invoke it with the name of the theme you
288 288 want to use.
... ... @@ -295,7 +295,7 @@ support getting themes from other repos as well in the future.
295 295 You can use this command to change your theme on the fly in your shell. Go on,
296 296 try out a few themes in your shell before you set it in your `.zshrc`.
297 297  
298   -## antigen-apply
  298 +### antigen-apply
299 299  
300 300 You have to add this command after defining all bundles you need, in your zshrc.
301 301 The completions defined by your bundles will be loaded at this step.
... ... @@ -309,7 +309,7 @@ However, if you're a zsh expert and can suggest a way so that this would not be
309 309 necessary, I am very interested in discussing it. Please open up an issue with
310 310 your details. Thanks.
311 311  
312   -# Configuration
  312 +## Configuration
313 313  
314 314 The following environment variables can be set to customize the behavior of
315 315 antigen. Make sure you set them *before* source-ing `antigen.zsh`.
... ... @@ -326,11 +326,11 @@ Defaults to `$HOME/.antigen`.
326 326 were used previously but are now removed. Please use `ADOTDIR` instead, as
327 327 mentioned above.
328 328  
329   -# Notes on writing plugins
  329 +## Notes on writing plugins
330 330  
331 331 > *TBD*
332 332  
333   -# Meta
  333 +## Meta
334 334  
335 335 Project is licensed with the [MIT License][license]. To contribute, just fork,
336 336 make changes and send a pull request. If its a rather long/complicated change,