psi-jack/zimfw
1
0
Fork 0
mirror of synced 2024-11-14 20:18:58 -05:00
Code Issues Releases Wiki Activity

add Modules page

Matt Hamilton 2015-12-16 17:52:53 -05:00
parent 042aa66027
commit a90b393a39
1 changed files with 45 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

45
Modules.md Normal file

@ -0,0 +1,45 @@
Modules
=======
Zim alone won't change your Zsh experience! By enabling modules, you pick what features you want.
A brief list of modules and their descriptions can be seen below. Clicking on the name of a module will take you to the full documentation for that module.
Any **bold** module provides functionality that greatly enhances the user experience. These are recommended modules!
Behaviour
--------
| Name | Description |
| ---- | ----------- |
| [**completion**](https://github.com/Eriner/zim/blob/master/modules/completion/README.md) | Enables and configures smart and extensive tab completion. |
| [directory](https://github.com/Eriner/zim/blob/master/modules/directory/README.md) | Sets smart directory, navigation, and redirect options. |
| [environment](https://github.com/Eriner/zim/blob/master/modules/environment/README.md) | Sets generic Zsh built-in environment options. |
| [**history-substring-search**](https://github.com/Eriner/zim/blob/master/modules/history-substring-search/README.md) | Allows for fish shell-like searching of history. |
| [history](https://github.com/Eriner/zim/blob/master/modules/history/README.md) | Sets sane history options. |
| [input](https://github.com/Eriner/zim/blob/master/modules/input/README.md) | Applies correct bindkeys for input events. |
| [**prompt**](https://github.com/Eriner/zim/blob/master/modules/prompt/README.md) | Initializes and provides customizable prompt themes. |
| [spectrum](https://github.com/Eriner/zim/blob/master/modules/spectrum/README.md) | Provides initialization for 256 colours and effects. |
| [**syntax-highlighting**](https://github.com/Eriner/zim/blob/master/modules/syntax-highlighting/README.md) | Adds fish shell-like syntax highlighting to your shell. |
Productivity
------------
| Name | Description |
| ---- | ----------- |
| [archive](https://github.com/Eriner/zim/blob/master/modules/archive/README.md) | Provides archive and unarchive functions for easy archive manipulation. |
| [**git**](https://github.com/Eriner/zim/blob/master/modules/git/README.md) | Provides nice git aliases and functions. |
| [ssh](https://github.com/Eriner/zim/blob/master/modules/ssh/README.md) | Provides a convenient way to load ssh-agent.|
| [**utility**](https://github.com/Eriner/zim/blob/master/modules/utility/README.md) | Adds utility aliases and functions. |
Distro-specific
---------------
| Name | Description |
| ---- | ----------- |
| [pacman](https://github.com/Eriner/zim/blob/master/modules/pacman/README.md) | Adds aliases for the pacman package manager. |