Skip to content

Commit 5be46b8

Browse files
committed
README.md to include the named dirs description.
1 parent f74b030 commit 5be46b8

File tree

1 file changed

+75
-0
lines changed

1 file changed

+75
-0
lines changed

β€ŽREADME.mdβ€Ž

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,59 @@
1+
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
2+
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
3+
**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)*
4+
5+
- [Zinit<a name="zinit"></a>](#zinita-namezinita)
6+
- [Zinit Wiki<a name="zinit-wiki"></a>](#zinit-wikia-namezinit-wikia)
7+
- [Install<a name="install"></a>](#installa-nameinstalla)
8+
- [Automatic<a name="automatic"></a>](#automatica-nameautomatica)
9+
- [Manual<a name="manual"></a>](#manuala-namemanuala)
10+
- [Usage<a name="usage"></a>](#usagea-nameusagea)
11+
- [Introduction<a name="introduction"></a>](#introductiona-nameintroductiona)
12+
- [Plugins and snippets<a name="plugins-and-snippets"></a>](#plugins-and-snippetsa-nameplugins-and-snippetsa)
13+
- [Upgrade Zinit and plugins<a name="upgrade-zinit-and-plugins"></a>](#upgrade-zinit-and-pluginsa-nameupgrade-zinit-and-pluginsa)
14+
- [Turbo and lucid<a name="turbo-and-lucid"></a>](#turbo-and-lucida-nameturbo-and-lucida)
15+
- [Migration<a name="migration"></a>](#migrationa-namemigrationa)
16+
- [Frequently Asked Questions<a name="frequently-asked-questions"></a>](#frequently-asked-questionsa-namefrequently-asked-questionsa)
17+
- [Use `zi ice svn` if a plugin/snippet requires an entire subdirectory<a name="use-zi-ice-svn-if-a-pluginsnippet-requires-an-entire-subdirectory"></a>](#use-zi-ice-svn-if-a-pluginsnippet-requires-an-entire-subdirectorya-nameuse-zi-ice-svn-if-a-pluginsnippet-requires-an-entire-subdirectorya)
18+
- [Use `zi ice as'completion'` to directly add single file completion snippets<a name="use-zi-ice-ascompletion-to-directly-add-single-file-completion-snippets"></a>](#use-zi-ice-ascompletion-to-directly-add-single-file-completion-snippetsa-nameuse-zi-ice-ascompletion-to-directly-add-single-file-completion-snippetsa)
19+
- [More Examples<a name="more-examples"></a>](#more-examplesa-namemore-examplesa)
20+
- [How to Use<a name="how-to-use"></a>](#how-to-usea-namehow-to-usea)
21+
- [Ice Modifiers<a name="ice-modifiers"></a>](#ice-modifiersa-nameice-modifiersa)
22+
- [Cloning Options<a name="cloning-options"></a>](#cloning-optionsa-namecloning-optionsa)
23+
- [Selection of Files (To Source, …)<a name="selection-of-files-to-source-%E2%80%A6"></a>](#selection-of-files-to-source-a-nameselection-of-files-to-source-a)
24+
- [Conditional Loading<a name="conditional-loading"></a>](#conditional-loadinga-nameconditional-loadinga)
25+
- [Plugin Output<a name="plugin-output"></a>](#plugin-outputa-nameplugin-outputa)
26+
- [Completions<a name="completions"></a>](#completionsa-namecompletionsa)
27+
- [Command Execution After Cloning, Updating or Loading<a name="command-execution-after-cloning-updating-or-loading"></a>](#command-execution-after-cloning-updating-or-loadinga-namecommand-execution-after-cloning-updating-or-loadinga)
28+
- [Sticky-Emulation Of Other Shells<a name="sticky-emulation-of-other-shells"></a>](#sticky-emulation-of-other-shellsa-namesticky-emulation-of-other-shellsa)
29+
- [Others<a name="others"></a>](#othersa-nameothersa)
30+
- [Order of Execution<a name="order-of-execution"></a>](#order-of-executiona-nameorder-of-executiona)
31+
- [Zinit Commands<a name="zinit-commands"></a>](#zinit-commandsa-namezinit-commandsa)
32+
- [Help<a name="help"></a>](#helpa-namehelpa)
33+
- [Loading and Unloading<a name="loading-and-unloading"></a>](#loading-and-unloadinga-nameloading-and-unloadinga)
34+
- [Completions<a name="completions-1"></a>](#completionsa-namecompletions-1a)
35+
- [Tracking of the Active Session<a name="tracking-of-the-active-session"></a>](#tracking-of-the-active-sessiona-nametracking-of-the-active-sessiona)
36+
- [Reports and Statistics<a name="reports-and-statistics"></a>](#reports-and-statisticsa-namereports-and-statisticsa)
37+
- [Compiling<a name="compiling"></a>](#compilinga-namecompilinga)
38+
- [Other<a name="other"></a>](#othera-nameothera)
39+
- [Updating Zinit and Plugins<a name="updating-zinit-and-plugins"></a>](#updating-zinit-and-pluginsa-nameupdating-zinit-and-pluginsa)
40+
- [Completions<a name="completions-2"></a>](#completionsa-namecompletions-2a)
41+
- [Calling `compinit` Without Turbo Mode<a name="calling-compinit-without-turbo-mode"></a>](#calling-compinit-without-turbo-modea-namecalling-compinit-without-turbo-modea)
42+
- [Calling `compinit` With Turbo Mode<a name="calling-compinit-with-turbo-mode"></a>](#calling-compinit-with-turbo-modea-namecalling-compinit-with-turbo-modea)
43+
- [Ignoring Compdefs<a name="ignoring-compdefs"></a>](#ignoring-compdefsa-nameignoring-compdefsa)
44+
- [Disabling System-Wide `compinit` Call (Ubuntu)<a name="disabling-system-wide-compinit-call-ubuntu"></a>](#disabling-system-wide-compinit-call-ubuntua-namedisabling-system-wide-compinit-call-ubuntua)
45+
- [Zinit Module<a name="zinit-module"></a>](#zinit-modulea-namezinit-modulea)
46+
- [Hints and Tips<a name="hints-and-tips"></a>](#hints-and-tipsa-namehints-and-tipsa)
47+
- [Customizing Paths<a name="customizing-paths"></a>](#customizing-pathsa-namecustomizing-pathsa)
48+
- [Non-GitHub (Local) Plugins<a name="non-github-local-plugins"></a>](#non-github-local-pluginsa-namenon-github-local-pluginsa)
49+
- [Extending Git<a name="extending-git"></a>](#extending-gita-nameextending-gita)
50+
- [Named directories for frequently used paths](#named-directories-for-frequently-used-paths)
51+
- [Changelog<a name="changelog"></a>](#changeloga-namechangeloga)
52+
- [Support<a name="support"></a>](#supporta-namesupporta)
53+
- [Getting Help and Community<a name="getting-help-and-community"></a>](#getting-help-and-communitya-namegetting-help-and-communitya)
54+
55+
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
56+
157
<p align="center">
258
<a href="https://github.com/zdharma-continuum/zinit">
359
<img src="https://raw.githubusercontent.com/zdharma-continuum/zinit/images/zinit.png"/>
@@ -1077,6 +1133,25 @@ zi as'null' lucid sbin wait'1' for \
10771133

10781134
Target directory for installed files is `$ZPFX` (`~/.local/share/zinit/polaris` by default).
10791135

1136+
### Named directories for frequently used paths
1137+
1138+
Named directories are shorthands in the form of `~NAMED_DIR`
1139+
(upper case not required). Zinit provides a set of such
1140+
names for its frequently used paths:
1141+
1142+
- *~ZIDIR* β†’ `$ZINIT[HOME_DIR]` – the home directory for others, like `plugins`, `snippets`, etc.
1143+
- *~ZIPLUGS* β†’ `$ZINIT[PLUGINS_DIR]` – the `plugins` dir,
1144+
- *~ZISNIPS* β†’ `$ZINIT[SNIPPETS_DIR]` – the `snippets` dir,
1145+
- *~ZICOMPS* β†’ `$ZINIT[COMPLETIONS_DIR]` – the `completions` dir, where all
1146+
completion functions reside`
1147+
- *~ZISERV* β†’ `$ZINIT[SERVICES_DIR]` – the `services` work dir for all loaded
1148+
services,
1149+
- *~ZICACHE* β†’ `$ZSH_CACHE_DIR` – the cache dir, usually `~/.cache/zinit`,
1150+
- *~ZIBIN* β†’ `$ZINIT[BIN_DIR]` – the directory with Zinit's binary scripts,
1151+
- *~ZPFX* β†’ the standard prefix for all `configure` and `make` commands, usually
1152+
`~ZIDIR/polaris`.
1153+
1154+
10801155
## Changelog<a name="changelog"></a>
10811156

10821157
Link to the [CHANGELOG](doc/CHANGELOG.md).

0 commit comments

Comments
Β (0)