Update modules' README.md
Stick with the following style: * Header 1 with the module name is in `lowercase`. * Other headers are in `Sentence case`. Common header names that should be consistently used are `Aliases`, `Contributing`, `Functions`, `Settings`, and `Zsh options`. * The names `Zim` and `Zsh` always appear capitalized, even in the middle of sentences. * Prefer print 'code indented with 4 spaces' instead of ```zsh print 'code fenced by lines with three back-ticks' print 'unless you want syntax highlighting' ```
This commit is contained in:
parent
ab41c4484d
commit
5b90c96cd1
13 changed files with 40 additions and 40 deletions
|
@ -1,7 +1,7 @@
|
||||||
zsh-autosuggestions
|
zsh-autosuggestions
|
||||||
===================
|
===================
|
||||||
|
|
||||||
_[Fish](http://fishshell.com/)-like fast/unobtrusive autosuggestions for zsh._
|
_[Fish](http://fishshell.com/)-like fast/unobtrusive autosuggestions for Zsh._
|
||||||
|
|
||||||
It suggests commands as you type, based on command history.
|
It suggests commands as you type, based on command history.
|
||||||
|
|
||||||
|
|
|
@ -1,18 +1,19 @@
|
||||||
Custom
|
custom
|
||||||
======
|
======
|
||||||
|
|
||||||
Add any custom aliases/settings to the `init.zsh` file.
|
Add any custom aliases/settings to the `init.zsh` file.
|
||||||
|
|
||||||
Any functions should go in the `functions` folder, where the name of the file is the name of the function.
|
Any functions should go in the `functions` subdirectory, where the name of the
|
||||||
|
file is the name of the function.
|
||||||
|
|
||||||
For example, this function from your .zshrc:
|
For example, this function from your `.zshrc`:
|
||||||
```
|
```zsh
|
||||||
foo() {
|
foo() {
|
||||||
print 'bar'
|
print 'bar'
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
becomes a file named 'foo' in the functions folder containing:
|
becomes a file named `foo` in the `functions` subdirectory containing:
|
||||||
```
|
```zsh
|
||||||
print 'bar'
|
print 'bar'
|
||||||
```
|
```
|
||||||
|
|
18
modules/debug/README.md
Normal file
18
modules/debug/README.md
Normal file
|
@ -0,0 +1,18 @@
|
||||||
|
debug
|
||||||
|
=====
|
||||||
|
|
||||||
|
Provides a function to debug Zim.
|
||||||
|
|
||||||
|
Functions
|
||||||
|
---------
|
||||||
|
|
||||||
|
* `trace-zim` provides a trace of Zsh/Zim startup
|
||||||
|
|
||||||
|
Notes
|
||||||
|
-----
|
||||||
|
|
||||||
|
`trace-zim` will not alter your current dotfiles. It will copy your environment
|
||||||
|
to a temporary directory, launch Zsh within that environment, and output logs.
|
||||||
|
|
||||||
|
This will provide a `ztrace.tar.gz` archive, which should be attached to any bug
|
||||||
|
reports if you need help with an issue that you don't understand.
|
|
@ -1,19 +0,0 @@
|
||||||
Debug
|
|
||||||
=====
|
|
||||||
|
|
||||||
Provides a function to debug Zim.
|
|
||||||
|
|
||||||
Functions
|
|
||||||
---------
|
|
||||||
|
|
||||||
- `trace-zim` provides a trace of Zsh/Zim startup
|
|
||||||
|
|
||||||
Notes
|
|
||||||
-----
|
|
||||||
|
|
||||||
The `trace-zim` command will not alter your current dotfiles.
|
|
||||||
It will copy your environment to a temporary directory, launch zsh
|
|
||||||
within that environment, and output logs.
|
|
||||||
|
|
||||||
This will provide a ztrace.tar.gz archive, which should be attached
|
|
||||||
to any bug reports if you need help with an issue that you don't understand.
|
|
|
@ -3,7 +3,7 @@ directory
|
||||||
|
|
||||||
Sets directory, navigation, and redirect options.
|
Sets directory, navigation, and redirect options.
|
||||||
|
|
||||||
zsh options
|
Zsh options
|
||||||
-----------
|
-----------
|
||||||
|
|
||||||
* `AUTO_CD` performs cd to a directory if the typed command is invalid, but is a directory.
|
* `AUTO_CD` performs cd to a directory if the typed command is invalid, but is a directory.
|
||||||
|
|
|
@ -1,13 +1,13 @@
|
||||||
environment
|
environment
|
||||||
===========
|
===========
|
||||||
|
|
||||||
Sets generic zsh built-in environment options.
|
Sets generic Zsh built-in environment options.
|
||||||
|
|
||||||
Also enables smart URL-pasting. This prevents the user from having to manually escape URLs.
|
Also enables smart URL-pasting. This prevents the user from having to manually escape URLs.
|
||||||
|
|
||||||
Uses `.zimrc` defined `${ztermtitle}` variable to set the terminal title, if defined.
|
Uses `.zimrc` defined `${ztermtitle}` variable to set the terminal title, if defined.
|
||||||
|
|
||||||
zsh options
|
Zsh options
|
||||||
-----------
|
-----------
|
||||||
|
|
||||||
* `AUTO_RESUME` resumes an existing job before creating a new one.
|
* `AUTO_RESUME` resumes an existing job before creating a new one.
|
||||||
|
|
|
@ -12,7 +12,7 @@ Git **1.7.2** is the
|
||||||
Settings
|
Settings
|
||||||
--------
|
--------
|
||||||
|
|
||||||
### Ignore Submodules
|
### Ignore submodules
|
||||||
|
|
||||||
Retrieving the status of a repository with submodules can take a long time.
|
Retrieving the status of a repository with submodules can take a long time.
|
||||||
So by default 'all' submodules are ignored. Optionally, 'untracked', 'dirty', or
|
So by default 'all' submodules are ignored. Optionally, 'untracked', 'dirty', or
|
||||||
|
@ -20,7 +20,7 @@ So by default 'all' submodules are ignored. Optionally, 'untracked', 'dirty', or
|
||||||
|
|
||||||
zstyle ':zim:git-info' ignore-submodules 'none'
|
zstyle ':zim:git-info' ignore-submodules 'none'
|
||||||
|
|
||||||
### Verbose Mode
|
### Verbose mode
|
||||||
|
|
||||||
Verbose mode uses `git status` and computes the count of indexed, unindexed and
|
Verbose mode uses `git status` and computes the count of indexed, unindexed and
|
||||||
also untracked files. It can be enabled with the following zstyle:
|
also untracked files. It can be enabled with the following zstyle:
|
||||||
|
@ -41,7 +41,7 @@ a style is:
|
||||||
|
|
||||||
zstyle ':zim:git-info:context' format 'string'
|
zstyle ':zim:git-info:context' format 'string'
|
||||||
|
|
||||||
### Main Contexts
|
### Main contexts
|
||||||
|
|
||||||
| Name | Code | Description
|
| Name | Code | Description
|
||||||
| --------- | :----: | --------------------------------------------------------
|
| --------- | :----: | --------------------------------------------------------
|
||||||
|
@ -65,7 +65,7 @@ state](http://gitfaq.org/articles/what-is-a-detached-head.html), on the other
|
||||||
hand, `ahead`, `behind`, `diverged`, `branch` and `remote` are only available
|
hand, `ahead`, `behind`, `diverged`, `branch` and `remote` are only available
|
||||||
when an actual branch is checked out (so when **not** in 'detached HEAD' state).
|
when an actual branch is checked out (so when **not** in 'detached HEAD' state).
|
||||||
|
|
||||||
### Special Action Contexts
|
### Special action contexts
|
||||||
|
|
||||||
| Name | Format | Default Value
|
| Name | Format | Default Value
|
||||||
| --------------------------- | :-----: | -------------------------------------
|
| --------------------------- | :-----: | -------------------------------------
|
||||||
|
|
|
@ -3,7 +3,7 @@ input
|
||||||
|
|
||||||
Applies correct bindkeys for input events.
|
Applies correct bindkeys for input events.
|
||||||
|
|
||||||
Without this module, you may experience oddities in how zsh interprets input.
|
Without this module, you may experience oddities in how Zsh interprets input.
|
||||||
For example, pressing LEFT and then the DELETE key may capitalize characters
|
For example, pressing LEFT and then the DELETE key may capitalize characters
|
||||||
rather than delete them.
|
rather than delete them.
|
||||||
|
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
Pacman
|
pacman
|
||||||
======
|
======
|
||||||
|
|
||||||
Adds aliases for the pacman package manager.
|
Adds aliases for the pacman package manager.
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
Prompt
|
prompt
|
||||||
======
|
======
|
||||||
|
|
||||||
Initializes and provides customizable prompt themes.
|
Initializes and provides customizable prompt themes.
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
SSH
|
ssh
|
||||||
===
|
===
|
||||||
|
|
||||||
Provides a convenient way to load ssh-agent. This enables one-time login and caching of SSH credentials per session.
|
Provides a convenient way to load ssh-agent. This enables one-time login and caching of SSH credentials per session.
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
Syntax-Highlighting
|
syntax-highlighting
|
||||||
===================
|
===================
|
||||||
|
|
||||||
Adds fish shell-like [syntax highlighting](https://github.com/zsh-users/zsh-syntax-highlighting) to your shell.
|
Adds fish shell-like [syntax highlighting](https://github.com/zsh-users/zsh-syntax-highlighting) to your shell.
|
||||||
|
|
|
@ -20,11 +20,11 @@ Aliases
|
||||||
* `lt` lists sorted by newest modification time last.
|
* `lt` lists sorted by newest modification time last.
|
||||||
* `lc` lists sorted by newest status change (ctime) last.
|
* `lc` lists sorted by newest status change (ctime) last.
|
||||||
|
|
||||||
### File Downloads
|
### File downloads
|
||||||
|
|
||||||
* `get` is short for ( `aria2c` || `axel` || `wget` || `curl` ).
|
* `get` is short for ( `aria2c` || `axel` || `wget` || `curl` ).
|
||||||
|
|
||||||
### Resource Usage
|
### Resource usage
|
||||||
|
|
||||||
* `df` reports file system disk usage with human-readable sizes.
|
* `df` reports file system disk usage with human-readable sizes.
|
||||||
* `du` reports file disk usage with human-readable sizes.
|
* `du` reports file disk usage with human-readable sizes.
|
||||||
|
|
Loading…
Reference in a new issue