From a90b393a3989b8b6064c47082d8782fdca036bd7 Mon Sep 17 00:00:00 2001 From: Matt Hamilton Date: Wed, 16 Dec 2015 17:52:53 -0500 Subject: [PATCH] add Modules page --- Modules.md | 45 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 Modules.md diff --git a/Modules.md b/Modules.md new file mode 100644 index 0000000..bd3e55c --- /dev/null +++ b/Modules.md @@ -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. | + +