mirror of
https://github.com/ohmyzsh/ohmyzsh.git
synced 2024-11-25 17:23:35 +01:00
Run markdown linting
Marc Cornellà
parent
2e8050a127
commit
3f737b2dbe
@ -1,6 +1,7 @@
|
||||
Here are a collection of blog posts and articles that mention Oh My Zsh.
|
||||
|
||||
If you know of any that are missing, feel free to contribute! :-)
|
||||
|
||||
- [[Setup your Mac with Zsh for Web development|https://medium.com/@vdeantoni/setting-up-your-mac-for-web-development-in-2020-659f5588b883]]
|
||||
- [[Oh-my-zsh install 2018 Tutorial|https://medium.com/wearetheledger/oh-my-zsh-made-for-cli-lovers-installation-guide-3131ca5491fb]]
|
||||
- [[Badassify your terminal and shell|http://jilles.me/badassify-your-terminal-and-shell/]]
|
||||
|
||||
@ -259,7 +259,6 @@ You also find these commands in Dash as a Cheat-sheet.
|
||||
| _sc-enable NAME_ | enable the NAME process to start at boot |
|
||||
| _sc-disable NAME_ | disable the NAME process at boot |
|
||||
|
||||
|
||||
## Rails
|
||||
|
||||
### Rails Aliases
|
||||
@ -278,7 +277,6 @@ You also find these commands in Dash as a Cheat-sheet.
|
||||
| _rsd_ | rails server --debugger |
|
||||
| _rsp_ | rails server --port |
|
||||
|
||||
|
||||
### RAILS_ENV Aliases
|
||||
|
||||
| Alias | Command |
|
||||
@ -297,4 +295,4 @@ You also find these commands in Dash as a Cheat-sheet.
|
||||
| `z foo/` | `cd` into relative path |
|
||||
| `z ..` | `cd` one level up |
|
||||
| `z -` | `cd` into previous directory |
|
||||
| `zi foo ` | `cd` with interactive selection (using `fzf`) |
|
||||
| `zi foo` | `cd` with interactive selection (using `fzf`) |
|
||||
|
||||
@ -15,11 +15,13 @@ Maximum line length is 80 characters.
|
||||
If you have to write strings that are longer than 80 characters, this should be done with a "here document" or an embedded newline if possible. Literal strings that have to be longer than 80 chars and can't sensibly be split are okay, but it's strongly preferred to find a way to make it shorter.
|
||||
|
||||
##### _Bad:_
|
||||
|
||||
```shell
|
||||
long_string_1="I am an exceptionalllllllllllly looooooooooooooooooooooooooooooooooooooooong string."
|
||||
```
|
||||
|
||||
##### _Good:_
|
||||
|
||||
```shell
|
||||
cat <<END;
|
||||
I am an exceptionalllllllllllly
|
||||
@ -28,6 +30,7 @@ END
|
||||
```
|
||||
|
||||
##### _Good:_
|
||||
|
||||
```shell
|
||||
long_string_2="I am an exceptionalllllllllllly
|
||||
looooooooooooooooooooooooooooooooooooooooong string."
|
||||
@ -42,11 +45,13 @@ If a pipeline all fits on one line, it should be on one line.
|
||||
If not, it should be split at one pipe segment per line with the pipe on the newline and a 2 space indent for the next section of the pipe. This applies to a chain of commands combined using '|' as well as to logical compounds using '||' and '&&'.
|
||||
|
||||
##### _Bad:_
|
||||
|
||||
```shell
|
||||
command1 | command2 | command3 | command4 | command5 | command6 | command7
|
||||
```
|
||||
|
||||
##### _Good:_
|
||||
|
||||
```shell
|
||||
command1 \
|
||||
| command2 \
|
||||
@ -55,30 +60,35 @@ command1 \
|
||||
```
|
||||
|
||||
##### _Good:_ All fits on one line
|
||||
|
||||
```shell
|
||||
command1 | command2
|
||||
```
|
||||
|
||||
### Use environment variables
|
||||
|
||||
When possible, use environment variables instead of shelling out to a command.
|
||||
|
||||
##### _Bad:_
|
||||
|
||||
```shell
|
||||
$(pwd)
|
||||
```
|
||||
|
||||
##### _Good:_
|
||||
|
||||
```shell
|
||||
$PWD
|
||||
```
|
||||
|
||||
TODO: Add a list of all environment variables you can use.
|
||||
|
||||
### If / For / While
|
||||
### If / For / While
|
||||
|
||||
Put `; do` and `; then` on the same line as the `while`, `for` or `if`.
|
||||
|
||||
##### _Good:_
|
||||
|
||||
```shell
|
||||
for dir in ${dirs_to_cleanup}; do
|
||||
if [[ -d "${dir}/${ORACLE_SID}" ]]; then
|
||||
@ -103,12 +113,14 @@ done
|
||||
Meaningful self-documenting names should be used. If the variable name does not make it reasonably obvious as to the meaning of the variable, appropriate comments should be added.
|
||||
|
||||
##### _Bad:_
|
||||
|
||||
```shell
|
||||
local TitleCase=""
|
||||
local camelCase=""
|
||||
```
|
||||
|
||||
##### _Good:_
|
||||
|
||||
```shell
|
||||
local snake_case=""
|
||||
```
|
||||
@ -116,11 +128,13 @@ local snake_case=""
|
||||
Uppercase strings are reserved for global variables. (WARNING: In functions, only variables explicitly declared as local like `local foo=""` are really local.)
|
||||
|
||||
##### _Bad:_
|
||||
|
||||
```shell
|
||||
local UPPERCASE=""
|
||||
```
|
||||
|
||||
##### _Good:_
|
||||
|
||||
```shell
|
||||
UPPERCASE=""
|
||||
```
|
||||
@ -128,11 +142,13 @@ UPPERCASE=""
|
||||
Variable names should not clobber command names, such as `dir` or `pwd`.
|
||||
|
||||
##### _Bad:_
|
||||
|
||||
```shell
|
||||
local pwd=""
|
||||
```
|
||||
|
||||
##### _Good:_
|
||||
|
||||
```shell
|
||||
local pwd_read_in=""
|
||||
```
|
||||
@ -140,6 +156,7 @@ local pwd_read_in=""
|
||||
Variable names for loop indexes should be named similarly to any variable you're looping through.
|
||||
|
||||
##### _Good:_
|
||||
|
||||
```shell
|
||||
for zone in ${zones}; do
|
||||
something_with "${zone}"
|
||||
@ -151,6 +168,7 @@ done
|
||||
Ensure that local variables are only seen inside a function and its children by using `local` or other `typeset` variants when declaring them. This avoids polluting the global name space and inadvertently setting or interacting with variables that may have significance outside the function.
|
||||
|
||||
##### _Bad:_
|
||||
|
||||
```shell
|
||||
function func_bad() {
|
||||
global_var=37 # Visible only within the function block
|
||||
@ -166,6 +184,7 @@ echo "global_var = $global_var" # global_var = 37
|
||||
```
|
||||
|
||||
##### _Good:_
|
||||
|
||||
```shell
|
||||
func_good() {
|
||||
local local_var=""
|
||||
@ -185,6 +204,7 @@ echo "global_var = $global_var" # move function result to global scope
|
||||
In the next example, lots of global variables are used over and over again, but the script "unfortunately" works anyway. The `parse_json()` function does not even return a value and the two functions shares their variables. You could also write all this without any function; this would have the same effect.
|
||||
|
||||
##### _Bad:_ with global variables
|
||||
|
||||
```shell
|
||||
#!/bin/bash
|
||||
|
||||
@ -229,6 +249,7 @@ echo "foobar: $counter - $i"
|
||||
In shell scripts, it is less common that you really want to reuse the functionality, but the code is much easier to read if you write small functions with appropriate return values and parameters.
|
||||
|
||||
##### _Good:_ with local variables
|
||||
|
||||
```shell
|
||||
#!/bin/zsh
|
||||
|
||||
@ -281,11 +302,13 @@ echo "foobar: $counter - $i"
|
||||
All caps, separated with underscores, declared at the top of the file. Constants and anything exported to the environment should be capitalized.
|
||||
|
||||
##### _Constant:_
|
||||
|
||||
```shell
|
||||
readonly PATH_TO_FILES='/some/path'
|
||||
```
|
||||
|
||||
##### _Constant and environment:_
|
||||
|
||||
```shell
|
||||
declare -xr ORACLE_SID='PROD'
|
||||
```
|
||||
@ -324,6 +347,7 @@ Lower-case, with underscores to separate words. Parentheses are required after t
|
||||
The opening brace should appear on the same line as the function name.
|
||||
|
||||
##### _Bad:_
|
||||
|
||||
```shell
|
||||
function my_bad_func {
|
||||
...
|
||||
@ -331,6 +355,7 @@ function my_bad_func {
|
||||
```
|
||||
|
||||
##### _Good:_
|
||||
|
||||
```shell
|
||||
my_good_func() {
|
||||
...
|
||||
@ -341,6 +366,7 @@ my_good_func() {
|
||||
Private or utility functions should be prefixed with an underscore:
|
||||
|
||||
##### _Good:_
|
||||
|
||||
```shell
|
||||
_helper-util() {
|
||||
...
|
||||
@ -352,6 +378,7 @@ _helper-util() {
|
||||
After a script or function terminates, a `$?` from the command line gives the exit status of the script, that is, the exit status of the last command executed in the script, which is, by convention, 0 on success or an integer in the range 1 - 255 on error.
|
||||
|
||||
##### _Bad:_
|
||||
|
||||
```shell
|
||||
my_bad_func() {
|
||||
# didn't work with zsh / bash is ok
|
||||
@ -370,6 +397,7 @@ my_bad_func() {
|
||||
```
|
||||
|
||||
##### _Good:_
|
||||
|
||||
```shell
|
||||
my_good_func() {
|
||||
# didn't work with zsh / bash is ok
|
||||
@ -395,16 +423,19 @@ my_good_func() {
|
||||
Always check return values and give informative error messages. For unpiped commands, use `$?` or check directly via an if statement to keep it simple. Use nonzero return values to indicate errors.
|
||||
|
||||
##### _Bad:_
|
||||
|
||||
```shell
|
||||
mv "${file_list}" "${dest_dir}/"
|
||||
```
|
||||
|
||||
##### _Good:_
|
||||
|
||||
```shell
|
||||
mv "${file_list}" "${dest_dir}/" || exit 1
|
||||
```
|
||||
|
||||
##### _Good:_
|
||||
|
||||
```shell
|
||||
if ! mv "${file_list}" "${dest_dir}/"; then
|
||||
echo "Unable to move ${file_list} to ${dest_dir}" >&2
|
||||
@ -413,6 +444,7 @@ fi
|
||||
```
|
||||
|
||||
##### _Good:_ use "$?" to get the last return value
|
||||
|
||||
```shell
|
||||
mv "${file_list}" "${dest_dir}/"
|
||||
if [[ "$?" -ne 0 ]]; then
|
||||
@ -430,11 +462,13 @@ Use `$(command)` instead of backticks.
|
||||
Nested backticks require escaping the inner ones with `\`. The `$(command)` format doesn't change when nested and is easier to read.
|
||||
|
||||
##### _Bad:_
|
||||
|
||||
```shell
|
||||
var="`command \`command1\``"
|
||||
```
|
||||
|
||||
##### _Good:_
|
||||
|
||||
```shell
|
||||
var="$(command "$(command1)")"
|
||||
```
|
||||
|
||||
@ -25,6 +25,7 @@ _This supposes that you have Oh-My-Zsh installed already in `$ZSH` (default:_ `~
|
||||
_All the following uses_ `<name>` _for the remote name, but you can use something else._
|
||||
|
||||
- **3.** Go to your local install directory and add your own repository as a remote
|
||||
|
||||
```shell
|
||||
cd $ZSH
|
||||
git remote add <name> git@github.com:<name>/oh-my-zsh.git
|
||||
@ -39,17 +40,20 @@ git remote add <name> git@github.com:<name>/oh-my-zsh.git
|
||||
### Maintained fork setup
|
||||
|
||||
- **3.** Go to your local install directory and rename the origin remote to "upstream"
|
||||
|
||||
```shell
|
||||
cd $ZSH
|
||||
git remote rename origin upstream
|
||||
```
|
||||
|
||||
- **4.** Then set your own repository as the origin remote
|
||||
|
||||
```shell
|
||||
git remote add origin git@github.com:<name>/oh-my-zsh.git
|
||||
```
|
||||
|
||||
**Upgrading:**
|
||||
|
||||
- **Upstream:** when you want to get the latest upgrades from the original repository (_aka_ upstream), simply `git pull upstream master`; you may have to solve conflicts with your own changes of course; when you are satisfied with the update you can `git push origin master`.
|
||||
- **Origin:** when you want to get the latest upgrades from your own fork (_aka_ origin), simply `git pull --rebase origin master`; you may have to solve conflicts with your local changes of course; when you are satisfied with the update you can `git push --force origin master`.
|
||||
|
||||
@ -68,6 +72,7 @@ _The following uses_ `my-new-pr` _for the branch name, but you can use something
|
||||
### Simple contribution PRs
|
||||
|
||||
- **1.** Any new PR must start from a clean upstream tree
|
||||
|
||||
```shell
|
||||
git checkout origin/master
|
||||
git checkout -b my-new-pr
|
||||
@ -76,6 +81,7 @@ git checkout -b my-new-pr
|
||||
You are now on your dedicated PR branch. Time to commit some changes!
|
||||
|
||||
- **2.** Send your commits
|
||||
|
||||
```shell
|
||||
git push <name> my-new-pr
|
||||
```
|
||||
@ -89,6 +95,7 @@ You can now go to GitHub and create the PR.
|
||||
### Maintained fork PRs
|
||||
|
||||
- **1.** Any new PR must start from a clean upstream tree
|
||||
|
||||
```shell
|
||||
git checkout upstream/master
|
||||
git checkout -b my-new-pr
|
||||
@ -97,6 +104,7 @@ git checkout -b my-new-pr
|
||||
You are now on your dedicated PR branch. Time to commit some changes!
|
||||
|
||||
- **2.** Send your commits
|
||||
|
||||
```shell
|
||||
git push origin my-new-pr
|
||||
```
|
||||
|
||||
@ -8,7 +8,7 @@ Initially `$ZSH_CUSTOM` points to oh-my-zsh's `custom` directory. Whatever you p
|
||||
|
||||
Let's say you created your own plugin `foobar` and want to add it to your configuration.
|
||||
|
||||
##### _~/.zshrc_
|
||||
##### `~/.zshrc`
|
||||
|
||||
```shell
|
||||
plugins=(git bundler foobar)
|
||||
@ -16,7 +16,7 @@ plugins=(git bundler foobar)
|
||||
|
||||
Then, create a `foobar` directory inside the `plugins` folder and an initialization script to launch your plugin. This script has to follow a naming convention, as all plugin files must have an ending of `.plugin.zsh`. Your file tree should look like this:
|
||||
|
||||
```
|
||||
```text
|
||||
$ZSH_CUSTOM
|
||||
└── plugins
|
||||
└── foobar
|
||||
@ -43,7 +43,7 @@ Adding and customizing your own themes pretty much works the same as with plugin
|
||||
|
||||
Themes are located in a `themes` folder and must end with `.zsh-theme`. The basename of the file is the name of the theme.
|
||||
|
||||
```
|
||||
```text
|
||||
$ZSH_CUSTOM
|
||||
└── themes
|
||||
└── my_awesome_theme.zsh-theme
|
||||
@ -63,7 +63,8 @@ If you don't change its filename, your `.zshrc` file can stay the same: `ZSH_THE
|
||||
|
||||
oh-my-zsh's internals are defined in its `lib` directory. To change them, just create a file inside the `custom` directory (its name doesn't matter, as long as it has a `.zsh` ending) and start customizing whatever you want. Unsatisfied with the way `git_prompt_info()` works? Write your own implementation!
|
||||
|
||||
##### _$ZSH_CUSTOM/my_patches.zsh_
|
||||
##### `$ZSH_CUSTOM/my_patches.zsh`
|
||||
|
||||
```shell
|
||||
function git_prompt_info() {
|
||||
# prove that you can do better
|
||||
@ -78,14 +79,15 @@ You can also fully override an existing `lib/*.zsh` file by providing a `$ZSH_CU
|
||||
|
||||
If you don't want to use the built-in `custom` directory itself, just change the path of `$ZSH_CUSTOM` inside your `.zshrc` to a directory of your own liking. Everything will be fine as long as you adhere to the conventional file hierarchy.
|
||||
|
||||
##### _~/.zshrc_
|
||||
##### `~/.zshrc`
|
||||
|
||||
```shell
|
||||
ZSH_CUSTOM=$HOME/my_customizations
|
||||
```
|
||||
|
||||
File tree inside of your home directory:
|
||||
|
||||
```
|
||||
```text
|
||||
$HOME
|
||||
└── my_customizations
|
||||
├── my_lib_patches.zsh
|
||||
|
||||
45
Design.md
45
Design.md
@ -12,12 +12,12 @@ What oh-my-zsh provides:
|
||||
- Configuration of zsh itself, enabling advanced features
|
||||
- Theming
|
||||
- Extra shell functionality & terse shortcuts
|
||||
- e.g. dir navigation
|
||||
- e.g. dir navigation
|
||||
- Integration with third party programs and commands
|
||||
- Completion, aliases, and auxiliary functions
|
||||
- Both OS-specific stuff and applications/utilities
|
||||
- Completion, aliases, and auxiliary functions
|
||||
- Both OS-specific stuff and applications/utilities
|
||||
- Auto-starting programs
|
||||
- e.g. the gpg-agent plugin
|
||||
- e.g. the gpg-agent plugin
|
||||
|
||||
It seems that plugins can get arbitrarily powerful and do whatever they want, so the user should understand what a given plugin does before enabling it.
|
||||
|
||||
@ -30,6 +30,7 @@ These are variables that base OMZ (excluding any plugins) uses. I've read throug
|
||||
At initialization time:
|
||||
|
||||
In oh-my-zsh.sh:
|
||||
|
||||
- `ZSH` - path to .oh-my-zsh (not zsh) installation
|
||||
- `plugins` - user-provided list of plugins to load
|
||||
- `ZSH_CUSTOM` – path to the oh-my-zsh (not zsh itself) customization dir
|
||||
@ -45,9 +46,9 @@ In oh-my-zsh.sh:
|
||||
- `ZSH_VERSION`
|
||||
- `ZDOTDIR`
|
||||
- Standard Unix environment variables
|
||||
- `HOME`
|
||||
- `HOST`
|
||||
- `OSTYPE`
|
||||
- `HOME`
|
||||
- `HOST`
|
||||
- `OSTYPE`
|
||||
|
||||
The only required one is `$ZSH`. The rest either have defaults, or undef is fine and has an expected behavior. (Though if $plugins is unset, the git plugin won't get loaded. Will that break stuff?) All these `ZSH_*` variables are OMZ-specific, not standard `zsh` stuff. Except for `ZSH_VERSION`, which is a standard parameter provided by `zsh`.
|
||||
|
||||
@ -56,6 +57,7 @@ The only required one is `$ZSH`. The rest either have defaults, or undef is fine
|
||||
In oh-my-zsh.sh:
|
||||
|
||||
At init:
|
||||
|
||||
- `SHORT_HOST`
|
||||
- `LSCOLORS`
|
||||
- `SCREEN_NO`
|
||||
@ -68,23 +70,26 @@ At init:
|
||||
- `BG`
|
||||
|
||||
At init (defaults if not provided):
|
||||
|
||||
- `ZSH_CUSTOM` - defaults to `$ZSH/custom`
|
||||
- `ZSH_CACHE_DIR` - defaults to `$ZSH/cache`
|
||||
- `ZSH_COMPDUMP`
|
||||
- `ZSH_SPECTRUM_TEXT`
|
||||
|
||||
Modified at init:
|
||||
|
||||
- `fpath`
|
||||
- `LC_CTYPE`
|
||||
|
||||
Leaks:
|
||||
|
||||
- `custom_config_file`
|
||||
|
||||
### Variables plugins use
|
||||
|
||||
- `URLTOOLS_METHOD` - plugins/urltools uses it to manually select node/php/perl/python/etc
|
||||
|
||||
## Oh-My-Zsh Initialization ##
|
||||
## Oh-My-Zsh Initialization
|
||||
|
||||
Oh-my-zsh is initialized for the current `zsh` session by sourcing `$ZSH/oh-my-zsh.sh`. This is typically done from `.zshrc`, and the oh-my-zsh installation process modifies the user's `.zshrc` to do so.
|
||||
|
||||
@ -101,22 +106,22 @@ The basic steps of the oh-my-zsh initialization process are as follows. Note tha
|
||||
The initialization steps in detail:
|
||||
|
||||
- Check for updates
|
||||
- Runs in a separate `zsh` process
|
||||
- Does not load OMZ, so it's independent and doesn't use any OMZ files
|
||||
- Runs in a separate `zsh` process
|
||||
- Does not load OMZ, so it's independent and doesn't use any OMZ files
|
||||
- Update `$fpath`: Add functions/ and completions/
|
||||
- (even though they don't exist in the current codebase)
|
||||
- (even though they don't exist in the current codebase)
|
||||
- Set `$ZSH_CUSTOM` and `$ZSH_CACHE_DIR`
|
||||
- Load lib ("config") files
|
||||
- Discovers and sources all lib files, in alphabetical order, respecting custom overrides
|
||||
- Discovers and sources all lib files, in alphabetical order, respecting custom overrides
|
||||
- Load custom user code
|
||||
- Source each `$ZSH_CUSTOM/*.zsh` file, in alphabetical order
|
||||
- Source each `$ZSH_CUSTOM/*.zsh` file, in alphabetical order
|
||||
- Pre-load plugins (add to `$fpath`, but don't source)
|
||||
- Set `$SHORT_HOST`
|
||||
- Initialize Completion support
|
||||
- Set `$ZSH_COMPDUMP`
|
||||
- Run `compinit`, using dump file
|
||||
- Set `$ZSH_COMPDUMP`
|
||||
- Run `compinit`, using dump file
|
||||
- Load plugins
|
||||
- Source each plugin specified in `$plugins`, in the order specified
|
||||
- Source each plugin specified in `$plugins`, in the order specified
|
||||
- Load theme
|
||||
|
||||
## Customization
|
||||
@ -128,6 +133,7 @@ Overriding internals can be done by adding `*.zsh` files to the `$ZSH_CUSTOM` ro
|
||||
It's not documented in the _Customization_ page, but `$ZSH_CUSTOM/lib/*.zsh` do override the corresponding internals lib files. If a custom one is present, it is sourced instead of the one in the distribution.
|
||||
|
||||
So, you can:
|
||||
|
||||
- Override lib/* files on a per-file basis (loaded instead of the base file of the same name)
|
||||
- Add arbitrary customization code that runs later and can redefine any function or variable from the core
|
||||
- Override plugins and themes on a per-plugin/theme basis (loaded instead of base)
|
||||
@ -144,6 +150,7 @@ The [Customization](https://github.com/ohmyzsh/ohmyzsh/wiki/Customization) wiki
|
||||
Oh-my-zsh plugins extend the core functionality of oh-my-zsh.
|
||||
|
||||
Plugins provide functionality in the following areas:
|
||||
|
||||
- Completion definitions
|
||||
- Functions
|
||||
- Aliases
|
||||
@ -163,6 +170,7 @@ OMZ turns on the `prompt_subst` shell option, and OMZ themes assume it is enable
|
||||
Themes set a variety of variables to control the appearance of the zsh prompt. They may also install hook functions. These variables are read by core OMZ functions like `git_prompt_info()` and used to modify their behavior and style their output.
|
||||
|
||||
Things themes do:
|
||||
|
||||
- Set `$PROMPT`, `$RPROMPT`, and related variables
|
||||
- Set `$LSCOLORS` and `$LS_COLORS`
|
||||
- Define hook functions
|
||||
@ -176,6 +184,7 @@ These variables are set by themes to control the prompt's appearance and other c
|
||||
- `ZSH_THEME_SCM_PROMPT_PREFIX` – used in `bzr_prompt_info()` from `lib/bzr.sh`
|
||||
|
||||
git_prompt_info():
|
||||
|
||||
- `ZSH_THEME_GIT_PROMPT_PREFIX`
|
||||
- `ZSH_THEME_GIT_PROMPT_SUFFIX`
|
||||
- `ZSH_THEME_GIT_COMMITS_AHEAD_PREFIX`
|
||||
@ -199,15 +208,18 @@ git_prompt_info():
|
||||
- `ZSH_THEME_GIT_PROMPT_UNTRACKED`
|
||||
|
||||
nvm_prompt_info():
|
||||
|
||||
- `ZSH_THEME_NVM_PROMPT_PREFIX`
|
||||
- `ZSH_THEME_NVM_PROMPT_SUFFIX`
|
||||
|
||||
rvm_prompt_info():
|
||||
|
||||
- `ZSH_THEME_RVM_PROMPT_PREFIX`
|
||||
- `ZSH_THEME_RVM_PROMPT_SUFFIX`
|
||||
- `ZSH_THEME_RVM_PROMPT_OPTIONS`
|
||||
|
||||
lib/termsupport.zsh:
|
||||
|
||||
- `ZSH_THEME_TERM_TAB_TITLE_IDLE`
|
||||
- `ZSH_THEME_TERM_TITLE_IDLE`
|
||||
|
||||
@ -221,6 +233,7 @@ Other `ZSH_THEME_*` variables may be used by different themes and plugins. The p
|
||||
Some per-theme custom variables:
|
||||
|
||||
In bureau.zsh-theme:
|
||||
|
||||
- `ZSH_THEME_GIT_PROMPT_STAGED`
|
||||
- `ZSH_THEME_GIT_PROMPT_UNSTAGED`
|
||||
- `ZSH_THEME_GIT_PROMPT_UNTRACKED`
|
||||
|
||||
@ -1,14 +1,17 @@
|
||||
## A list of plugins that don't come bundled with oh-my-zsh
|
||||
|
||||
There is no restriction for adding your plugin into zsh bundle (unlike [themes](https://github.com/ohmyzsh/ohmyzsh/wiki/External-themes)) but the rationale for creating this page is next:
|
||||
|
||||
* sometimes you're not really sure if your plugin will not harm (e.g. it can break something).
|
||||
|
||||
### Installation
|
||||
|
||||
It should be clear from [this](https://github.com/ohmyzsh/ohmyzsh/wiki/Customization#overriding-and-adding-plugins).
|
||||
|
||||
### The plugins
|
||||
|
||||
#### Custom git plugin
|
||||
|
||||
Fixes some inconsistencies in the default git plugin that make the aliases more intuitive, while adding some other useful functions.
|
||||
|
||||
You can get it from [here](https://github.com/davidde/git).
|
||||
@ -42,7 +45,7 @@ And get your doge [here](https://github.com/txstc55/dogesay/blob/master/dogesay.
|
||||
|
||||
Give tab-completions to `z`.
|
||||
|
||||
[](https://github.com/changyuheng/fz/blob/master/fz-demo.gif)
|
||||
[](https://github.com/changyuheng/fz/blob/master/fz-demo.gif)
|
||||
|
||||
Get it [here](https://github.com/changyuheng/fz).
|
||||
|
||||
@ -52,16 +55,21 @@ Get it [here](https://github.com/changyuheng/fz).
|
||||
**Maintainer:** [guiferpa](https://github.com/guiferpa)
|
||||
|
||||
##### Description
|
||||
|
||||
This plugin show platforms version
|
||||
|
||||
##### Support
|
||||
|
||||
[Nodejs](https://nodejs.org), [NPM](https://www.npmjs.com), [Docker](https://www.docker.com), [Go](https://golang.org), [Python](https://www.python.org), [Elixir](https://elixir-lang.org) and [Ruby](https://www.ruby-lang.org)
|
||||
|
||||
##### Demo
|
||||
|
||||
|
||||
|
||||
#### [xxh](https://github.com/xxh/xxh) - bring Oh My Zsh wherever you go through the SSH
|
||||
|
||||
Some users may want to use Oh My Zsh during the SSH connections. There is [xxh project](https://github.com/xxh/xxh) that allows bring Zsh with Oh My Zsh framework to the remote host without any installations, root access or affection on the host.
|
||||
|
||||
#### [zshnotes](https://github.com/jameshgrn/zshnotes)
|
||||
|
||||
A small, tidy, lightweight notes app that creates a daily text file and timestamps every line of added text
|
||||
|
||||
@ -34,11 +34,7 @@ Author: [@sebastianpulido](https://github.com/sebastianpulido)
|
||||
|
||||
The **new Kali Linux** console adapted to Ubuntu (and maybe any distro)!
|
||||
|
||||
```
|
||||
To install it, it is as easy as running the single INSTALLER.sh file
|
||||
```
|
||||
|
||||
|
||||
> To install it, it is as easy as running the single INSTALLER.sh file.
|
||||
|
||||
* Install: [how to install](https://github.com/alejandromume/ubunly-zsh-theme#install)
|
||||
|
||||
@ -48,7 +44,8 @@ To install it, it is as easy as running the single INSTALLER.sh file
|
||||
---
|
||||
|
||||
#### bigpath
|
||||
|
||||
|
||||
|
||||
|
||||
This theme can show your username, your current directory + the one before, git information (branch and unstaged/uncommited changes), and the current time.
|
||||
Pink dot means unstaged, purple dot means uncommitted.
|
||||
@ -57,6 +54,7 @@ Author: [@Tesohh](https://github.com/Tesohh)
|
||||
[Repo](https://github.com/Tesohh/omzbigpath)
|
||||
|
||||
---
|
||||
|
||||
#### ✏️✅ emoji
|
||||
|
||||
emoji theme for [oh-my-zsh](https://github.com/ohmyzsh/ohmyzsh/). simplified *robbyrussell* and replaced git prompt symbol with emoji for better clarity. Works fine on Macs.
|
||||
@ -72,12 +70,15 @@ Then change current theme to emoji ```ZSH_THEME=emoji``` in your ```~/.zshrc```.
|
||||
Activate a new theme with ```$ source ~/.zshrc```.
|
||||
|
||||
##### Syntax
|
||||
- ```➜ current_dir (git_branch) <emoji indicator>```
|
||||
- ✏️ Git prompt is dirty (uncommitted files)
|
||||
- ✅ Git prompt is clean (committed)
|
||||
|
||||
* ```➜ current_dir (git_branch) <emoji indicator>```
|
||||
|
||||
* ✏️ Git prompt is dirty (uncommitted files)
|
||||
* ✅ Git prompt is clean (committed)
|
||||
|
||||
##### Issues
|
||||
- ✏️ emoji is breaking cursor potion to the right hover on the first character on Crostini terminal
|
||||
|
||||
* ✏️ emoji is breaking cursor potion to the right hover on the first character on Crostini terminal
|
||||
|
||||
source: [repo](https://github.com/masaakifuruki/emoji.zsh-theme)
|
||||
|
||||
@ -120,17 +121,18 @@ author: [@masaakifuruki](https://github.com/masaakifuruki)
|
||||
</p></a>
|
||||
|
||||
**Quick start**
|
||||
|
||||
```shell
|
||||
npm install -g typewritten
|
||||
# then reload zsh
|
||||
```
|
||||
|
||||
**Features**
|
||||
- Asynchronous git info
|
||||
- 100% customizable
|
||||
- Actively maintained
|
||||
- [Thorough documentation](https://typewritten.dev)
|
||||
|
||||
* Asynchronous git info
|
||||
* 100% customizable
|
||||
* Actively maintained
|
||||
* [Thorough documentation](https://typewritten.dev)
|
||||
|
||||
Repository: [typewritten.zsh](https://github.com/reobin/typewritten)
|
||||
|
||||
@ -139,13 +141,13 @@ Documentation: [typewritten.dev](https://typewritten.dev)
|
||||
Author: [@reobin](https://github.com/reobin)
|
||||
|
||||
---
|
||||
|
||||
#### guezwhoz
|
||||
|
||||
|
||||
|
||||
- Single git status marker for Visual Studio Code and Git cli
|
||||
- Interactive `Tab` completer
|
||||
|
||||
* Single git status marker for Visual Studio Code and Git cli
|
||||
* Interactive `Tab` completer
|
||||
|
||||
source: [repo](https://github.com/guesswhozzz/guezwhoz-zshell)
|
||||
|
||||
@ -154,6 +156,7 @@ author: [@guesswhozzz](https://github.com/guesswhozzz)
|
||||
---
|
||||
|
||||
#### Aphrodite Theme
|
||||
|
||||
|
||||
|
||||
Minimalistic Aphrodite theme does not have any visual noise. Displays only the necessary information: current user, hostname, working directory, git branch if exists. Looks great both with dark and white terminals.
|
||||
@ -162,7 +165,9 @@ See [repository](https://github.com/win0err/aphrodite-terminal-theme) for source
|
||||
Author: [@win0err](https://github.com/win0err)
|
||||
|
||||
---
|
||||
|
||||
#### MacOS Terminal
|
||||
|
||||
<h3 align="center"><a href="https://github.com/alejandromume/macos-zsh-theme">MacOS Terminal</a></h3>
|
||||
|
||||
<p align="center">
|
||||
@ -202,6 +207,7 @@ The minimal MacOS terminal brought to ZSH
|
||||
* Author: [@alejandromume](https://github.com/alejandromume)
|
||||
|
||||
---
|
||||
|
||||
#### short
|
||||
|
||||
<img src=https://github.com/nikhilkmr300/omz-themes/blob/master/images/short.png width=640>
|
||||
@ -210,6 +216,7 @@ If long prompts annoy you, this theme is for you!
|
||||
It does away with the long path after the username, and retains only the basename of the current working directory in the prompt.
|
||||
|
||||
Features:
|
||||
|
||||
* Colored input to shell to easily differentiate it from the output of commands.
|
||||
* No annoying long prompts.
|
||||
* Option to keep/hide the virtual environment name.
|
||||
@ -226,6 +233,7 @@ Author: [@nikhilkmr300](https://github.com/nikhilkmr300)
|
||||
<img src=https://github.com/nikhilkmr300/omz-themes/blob/master/images/matte-black-yellow-line.png width=640>
|
||||
|
||||
Features:
|
||||
|
||||
* Colored input to shell to easily differentiate it from the output of commands.
|
||||
* Current git branch being checked out indicated at the end of the prompt.
|
||||
* Option to keep/hide the virtual environment name.
|
||||
@ -243,6 +251,7 @@ Author: [@nikhilkmr300](https://github.com/nikhilkmr300)
|
||||
<img src=https://github.com/nikhilkmr300/omz-themes/blob/master/images/color-input-line.png width=640>
|
||||
|
||||
Features:
|
||||
|
||||
* Colored input to shell to easily differentiate it from the output of commands.
|
||||
* Current git branch being checked out indicated at the end of the prompt.
|
||||
* Option to keep/hide the virtual environment name.
|
||||
@ -264,6 +273,7 @@ Powerline looking zsh theme with rvm prompt, git status and branch, current time
|
||||
Influenced heavily by agnoster's theme and jeremyFreeAgent's theme
|
||||
|
||||
Author: [@maverick9000](https://github.com/maverick9000)
|
||||
|
||||
#### Daivasmara
|
||||
|
||||
|
||||
@ -274,7 +284,6 @@ Source: [daivasmara.zsh-theme](https://github.com/Daivasmara/daivasmara.zsh-them
|
||||
|
||||
Author: [@Daivasmara](https://github.com/Daivasmara)
|
||||
|
||||
|
||||
---
|
||||
|
||||
#### Ducula
|
||||
@ -308,6 +317,7 @@ Author: [@rafaelsq](https://github.com/rafaelsq/)
|
||||
---
|
||||
|
||||
#### Reggae Theme
|
||||
|
||||
|
||||
|
||||
See [gist](https://gist.github.com/mgimenez/ae1cde0b637e844da885cb093a916126) for source.
|
||||
@ -315,7 +325,9 @@ See [gist](https://gist.github.com/mgimenez/ae1cde0b637e844da885cb093a916126) fo
|
||||
Author: [@mgimenez](https://github.com/mgimenez/)
|
||||
|
||||
---
|
||||
|
||||
### Intika Theme
|
||||
|
||||
|
||||
|
||||
See [repo](https://github.com/Intika-Linux-Apps/Oh-My-Zsh-Intika/blob/master/themes/intika.zsh-theme) for source.
|
||||
@ -323,7 +335,9 @@ See [repo](https://github.com/Intika-Linux-Apps/Oh-My-Zsh-Intika/blob/master/the
|
||||
Author: [Intika](https://github.com/intika)
|
||||
|
||||
---
|
||||
|
||||
### Philthy Theme
|
||||
|
||||
|
||||
|
||||
See [repo](https://gist.github.com/philFernandez/56f8953722285834cc9000ffcfe103f4#file-philthy-zsh-theme) for source.
|
||||
@ -331,14 +345,18 @@ See [repo](https://gist.github.com/philFernandez/56f8953722285834cc9000ffcfe103f
|
||||
Author: [Phil Fernandez](https://github.com/philFernandez) (philFernandez)
|
||||
|
||||
---
|
||||
|
||||
### Minimal Improved theme
|
||||
|
||||
|
||||
|
||||
See [repo](https://github.com/gdsrosa/minimal_improved)
|
||||
Author: [@gdsrosa](https://github.com/gdsrosa)
|
||||
|
||||
---
|
||||
|
||||
#### kmac theme
|
||||
|
||||
|
||||
|
||||
Simple theme that cleanly shows:
|
||||
@ -350,25 +368,26 @@ Author: [@koreymacdougall](https://github.com/koreymacdougall)
|
||||
---
|
||||
|
||||
#### Fishy2
|
||||
|
||||
|
||||
|
||||
See [repository](https://github.com/akinjide/fishy2) for source.
|
||||
|
||||
Author: [@akinjide](https://github.com/akinjide)
|
||||
|
||||
***
|
||||
|
||||
---
|
||||
|
||||
#### abaykan
|
||||
|
||||
<br>
|
||||
See [repository](https://github.com/abaykan/Mine/blob/master/abaykan.zsh-theme) for source.
|
||||
|
||||
Author: [@abaykan](https://github.com/abaykan)
|
||||
|
||||
***
|
||||
|
||||
---
|
||||
|
||||
#### Oxide
|
||||
|
||||
|
||||
|
||||
See [repository](https://github.com/dikiaap/dotfiles) for source.
|
||||
@ -376,6 +395,7 @@ See [repository](https://github.com/dikiaap/dotfiles) for source.
|
||||
Author: [@dikiaap](https://github.com/dikiaap)
|
||||
|
||||
#### Windows CMD
|
||||
|
||||
|
||||
|
||||
See [repository](https://github.com/juliavallina/windows-zsh-theme) for source.
|
||||
@ -392,7 +412,8 @@ author: [@sobolevn](https://github.com/sobolevn)
|
||||
#### xxf
|
||||
|
||||
|
||||
- Show Current commit shorten hash and message
|
||||
|
||||
* Show Current commit shorten hash and message
|
||||
See [Gist](https://gist.github.com/xfanwu/18fd7c24360c68bab884) for source.
|
||||
|
||||
author: [@xfanwu](https://github.com/xfanwu)
|
||||
@ -415,6 +436,7 @@ See [Repo](https://github.com/bhilburn/powerlevel9k) for source & documentation.
|
||||
author: [@bhilburn](https://github.com/bhilburn)
|
||||
|
||||
#### powerlevel10k
|
||||
|
||||
|
||||
Powerlevel10k is a backward-compatible reimplementation of the popular Powerlevel9k theme (see above) with 10-100 times better performance. When given the same configuration options it will generate the same prompt.
|
||||
|
||||
@ -433,26 +455,28 @@ Bullet Train is a oh-my-zsh shell theme based on the Powerline Vim plugin. It ai
|
||||
|
||||
It currently shows:
|
||||
|
||||
- Current Python virtualenv
|
||||
- Current Ruby version and gemset, through RVM
|
||||
- Current Node.js version, through NVM
|
||||
- Git status
|
||||
- Timestamp
|
||||
- Current directory
|
||||
- Background jobs
|
||||
- Exit code of last command
|
||||
* Current Python virtualenv
|
||||
* Current Ruby version and gemset, through RVM
|
||||
* Current Node.js version, through NVM
|
||||
* Git status
|
||||
* Timestamp
|
||||
* Current directory
|
||||
* Background jobs
|
||||
* Exit code of last command
|
||||
|
||||
See [Repo](https://github.com/caiogondim/bullet-train-oh-my-zsh-theme) for source
|
||||
|
||||
author: [@caiogondim](https://github.com/caiogondim)
|
||||
|
||||
#### Cordial
|
||||
|
||||
[](https://raw.githubusercontent.com/stevelacy/cordial-zsh-theme/master/screenshot.png)
|
||||
|
||||
See [repository](https://github.com/stevelacy/cordial-zsh-theme) for source.
|
||||
|
||||
Additional setup:
|
||||
- Install [node.js](https://nodejs.org/) to parse `package.json` files
|
||||
|
||||
* Install [node.js](https://nodejs.org/) to parse `package.json` files
|
||||
|
||||
#### Gitster
|
||||
|
||||
@ -502,13 +526,13 @@ Author: [@fjpalacios](https://github.com/fjpalacios)
|
||||
|
||||
It currently shows:
|
||||
|
||||
- Git status
|
||||
- 🕕 Time
|
||||
- `~/Desktop` Working directory
|
||||
- > where you type your cmds
|
||||
- `✹git:master` **color : Red** unstaged commit
|
||||
- `git:master` **color: White** committed files
|
||||
- `○` shows if current directory is a git folder || git branch
|
||||
* Git status
|
||||
* 🕕 Time
|
||||
* `~/Desktop` Working directory
|
||||
* > where you type your cmds
|
||||
* `✹git:master` **color : Red** unstaged commit
|
||||
* `git:master` **color: White** committed files
|
||||
* `○` shows if current directory is a git folder || git branch
|
||||
|
||||
See [repository](https://github.com/akinjide/chi) for source.
|
||||
|
||||
@ -517,9 +541,10 @@ Author: [@akinjide](https://github.com/akinjide)
|
||||
#### Haribo theme
|
||||
|
||||
|
||||
- Works with most console fonts
|
||||
- simple git status
|
||||
- timestamp
|
||||
|
||||
* Works with most console fonts
|
||||
* simple git status
|
||||
* timestamp
|
||||
|
||||
See [Repo](https://github.com/haribo/omz-haribo-theme) for source
|
||||
|
||||
@ -536,10 +561,11 @@ author: [Schminitz](https://github.com/schminitz)/[@Schminitz](https://twitter.c
|
||||
#### Odin theme
|
||||
|
||||
|
||||
- Git focused development.
|
||||
- A clean and distraction free programming environment.
|
||||
- Know the status of your repository throughout the development process
|
||||
- tmux and git configuration files included with the theme
|
||||
|
||||
* Git focused development.
|
||||
* A clean and distraction free programming environment.
|
||||
* Know the status of your repository throughout the development process
|
||||
* tmux and git configuration files included with the theme
|
||||
See [odin](https://github.com/tylerreckart/odin) for source.
|
||||
|
||||
author: [@tylerreckart](https://github.com/tylerreckart)
|
||||
@ -547,11 +573,12 @@ author: [@tylerreckart](https://github.com/tylerreckart)
|
||||
#### HYPERZSH theme
|
||||
|
||||
|
||||
- Git status
|
||||
- Timestamp
|
||||
- Current directory
|
||||
- Background jobs
|
||||
- Exit code of last command
|
||||
|
||||
* Git status
|
||||
* Timestamp
|
||||
* Current directory
|
||||
* Background jobs
|
||||
* Exit code of last command
|
||||
|
||||
See [hyperzsh](https://github.com/tylerreckart/hyperzsh) for source.
|
||||
|
||||
@ -560,6 +587,7 @@ author: [@tylerreckart](https://github.com/tylerreckart)
|
||||
### Hyper Oh-My-ZSH
|
||||
|
||||
|
||||
|
||||
* Oh-My-ZSH theme based on hyper terminal default theme 😎
|
||||
|
||||
source: [here](https://github.com/willmendesneto/hyper-oh-my-zsh)
|
||||
@ -568,6 +596,7 @@ author: [@willmendesneto](https://github.com/willmendesneto)
|
||||
#### Lambda (Mod) theme
|
||||
|
||||
|
||||
|
||||
* A simple yet elegant theme with git focused development.
|
||||
See [lambda-mod](https://github.com/halfo/lambda-mod-zsh-theme/) for source.
|
||||
|
||||
@ -576,6 +605,7 @@ author: [@halfo](https://github.com/halfo)
|
||||
#### Hedgehog theme
|
||||
|
||||
|
||||
|
||||
* Simple, no-nonsense and clean, with support for git and return codes.
|
||||
|
||||
source: [here](https://gist.github.com/hedgehog1029/dfbb7e66511e2c399157)
|
||||
@ -591,6 +621,7 @@ author: [@skuridin](https://github.com/skuridin)
|
||||
#### classyTouch Theme
|
||||
|
||||
|
||||
|
||||
* A very minimal, clean theme with git support.
|
||||
|
||||
source: [here](https://github.com/yarisgutierrez/classyTouch_oh-my-zsh)
|
||||
@ -688,11 +719,11 @@ AgnosterZak is a oh-my-zsh shell theme based on the Powerline Vim plugin & Agnos
|
||||
|
||||
It currently shows:
|
||||
|
||||
- Battery Life (in case of the laptop is not charging)
|
||||
- Current Date & Time
|
||||
- Current directory
|
||||
- Git status
|
||||
- User & Host status
|
||||
* Battery Life (in case of the laptop is not charging)
|
||||
* Current Date & Time
|
||||
* Current directory
|
||||
* Git status
|
||||
* User & Host status
|
||||
|
||||
See [Repo](https://github.com/zakaziko99/agnosterzak-ohmyzsh-theme) for source
|
||||
|
||||
@ -709,6 +740,7 @@ source: [Repo](https://github.com/marszall87/nodeys-zsh-theme) for source
|
||||
author: [@marszall87](https://github.com/marszall87)
|
||||
|
||||
#### Ciacho
|
||||
|
||||
|
||||
|
||||
Ciacho is theme based on agnoster.
|
||||
@ -717,8 +749,8 @@ See [Repo](https://github.com/Ciacho/ciacho-ohmyzsh-theme) for source.
|
||||
|
||||
author: [@Ciacho](https://github.com/Ciacho/)
|
||||
|
||||
|
||||
#### igorsilva
|
||||
|
||||
|
||||
|
||||
##### What it shows
|
||||
@ -733,11 +765,13 @@ See [Repo](https://github.com/igor9silva/zsh-theme) for source.
|
||||
author: [@igor9silva](https://github.com/igor9silva/)
|
||||
|
||||
#### nt9
|
||||
|
||||
|
||||
|
||||
A clean, distraction free and git focused development theme.
|
||||
|
||||
##### It currently shows:
|
||||
|
||||
* Show the location from git's root folder (when in a git repo) or show from home `~`
|
||||
* Show current sha()
|
||||
* Show current branch name
|
||||
@ -749,11 +783,13 @@ See [Repo](https://github.com/lenguyenthanh/nt9-oh-my-zsh-theme) for source.
|
||||
author: [@lenguyenthanh](https://github.com/lenguyenthanh)
|
||||
|
||||
#### jovial
|
||||
|
||||
|
||||
|
||||
pretty face, feel more jovial with this theme.
|
||||
|
||||
##### It currently shows:
|
||||
It currently shows:
|
||||
|
||||
* Show Host and User
|
||||
* Show current path
|
||||
* Show development environment segment
|
||||
@ -774,19 +810,19 @@ geometry is a minimalistic, fully customizable zsh prompt theme.
|
||||
|
||||
##### What it does:
|
||||
|
||||
- work asynchronously to speed up the prompt
|
||||
- display current git branch
|
||||
- display git state of the repo and time since last commit
|
||||
- tell you whether you need to pull, push or if you're mid-rebase
|
||||
- display the number of conflicting files and total number of conflicts
|
||||
- display the running time of long running commands
|
||||
- optionally display random colors based on your hostname
|
||||
- give you a custom, colorizable prompt symbol
|
||||
- change the prompt symbol color depending on the last command exit status
|
||||
- show virtualenv and docker machine data
|
||||
- set the terminal title to current command and directory
|
||||
- fully customizable, allowing you to change anything through environment variables
|
||||
- make you the coolest hacker in the whole Starbucks
|
||||
* work asynchronously to speed up the prompt
|
||||
* display current git branch
|
||||
* display git state of the repo and time since last commit
|
||||
* tell you whether you need to pull, push or if you're mid-rebase
|
||||
* display the number of conflicting files and total number of conflicts
|
||||
* display the running time of long running commands
|
||||
* optionally display random colors based on your hostname
|
||||
* give you a custom, colorizable prompt symbol
|
||||
* change the prompt symbol color depending on the last command exit status
|
||||
* show virtualenv and docker machine data
|
||||
* set the terminal title to current command and directory
|
||||
* fully customizable, allowing you to change anything through environment variables
|
||||
* make you the coolest hacker in the whole Starbucks
|
||||
|
||||
See [repo](https://github.com/frmendes/geometry) for source. We welcome any contributions!
|
||||
|
||||
@ -840,6 +876,7 @@ See [repo](https://github.com/dannynimmo/punctual-zsh-theme) for installation.
|
||||
By [Danny](https://github.com/dannynimmo).
|
||||
|
||||
#### Staples
|
||||
|
||||
|
||||
|
||||
A modified version of the Bureau theme with context-sensitive tags, ssh status, and last exit code coloring.
|
||||
@ -849,6 +886,7 @@ See [repo](https://github.com/dersam/staples) for source.
|
||||
Author: [@dersam](https://github.com/dersam)
|
||||
|
||||
#### Bunnyruni
|
||||
|
||||
|
||||
|
||||
Simple, clean, and beautiful theme inspired in my fovorite themes, functions and colors.
|
||||
@ -866,7 +904,6 @@ Single-line boring/traditional prompt without distracting colours, providing ext
|
||||
See [repo](https://github.com/xfxf/zsh-theme-traditional-plus) for source.
|
||||
Author: [@xfxf](https://github.com/xfxf)
|
||||
|
||||
|
||||
#### oh-wonder
|
||||
|
||||
|
||||
@ -876,10 +913,9 @@ Just another funky theme.
|
||||
See [repo](https://gist.github.com/kaushik94/a54e128869c0c82bdbed31d56c710daa) for source.
|
||||
Author: [@kaushik94](https://gist.github.com/kaushik94)
|
||||
|
||||
|
||||
#### rafiki-zsh
|
||||
|
||||
|
||||
|
||||
|
||||
A zsh friend to watch over you.
|
||||
|
||||
@ -896,7 +932,6 @@ source: [Repo](https://github.com/marszall87/lambda-pure) for source
|
||||
|
||||
author: [@marszall87](https://github.com/marszall87)
|
||||
|
||||
|
||||
#### Imperator / Imperator Root
|
||||
|
||||
|
||||
@ -941,7 +976,6 @@ See [Repo](https://github.com/eendroroy/alien) for source & documentation.
|
||||
|
||||
author: [@eendroroy](https://github.com/eendroroy)
|
||||
|
||||
|
||||
#### alien-minimal
|
||||
|
||||
[](https://asciinema.org/a/264037)
|
||||
@ -960,8 +994,8 @@ See [Repo](https://github.com/eendroroy/alien-minimal) for source & documentatio
|
||||
|
||||
author: [@eendroroy](https://github.com/eendroroy)
|
||||
|
||||
|
||||
#### Imp
|
||||
|
||||
|
||||
|
||||
Simple theme based on [Zork](https://github.com/Bash-it/bash-it/wiki/Themes#zork).
|
||||
@ -970,8 +1004,8 @@ See [repo](https://github.com/igormp/Imp) for source and install instructions.
|
||||
|
||||
Author: [@igormp](https://github.com/igormp)
|
||||
|
||||
|
||||
#### Omega
|
||||
|
||||
|
||||
|
||||
A clean, minimal theme.
|
||||
@ -981,6 +1015,7 @@ See [repo](https://github.com/Section214/zsh-omega) for source and install instr
|
||||
Author: [@igormp](https://github.com/igormp)
|
||||
|
||||
#### Docker-ZSH
|
||||
|
||||
This theme is pretty much based on the 'bureau' theme. It has been extended by a `DOCKER_HOST` live view,
|
||||
so that in every terminal session you see immediately which docker host is configured and where the local
|
||||
docker commands are forwarded to.
|
||||
@ -1042,14 +1077,12 @@ See [repository](https://github.com/w33tmaricich/enlightenment) for source & doc
|
||||
|
||||
Author: [@w33tmaricich](http://w33tmaricich.com)
|
||||
|
||||
|
||||
#### iGeek
|
||||
|
||||
|
||||
|
||||
See [repository](https://github.com/Saleh7/igeek-zsh-theme) for source.
|
||||
|
||||
|
||||
#### ASCIIGit
|
||||
|
||||
ASCII-only ZSH prompt theme (using oh-my-zsh) for git users who are not fan of fancy glyphs.
|
||||
@ -1057,35 +1090,34 @@ ASCII-only ZSH prompt theme (using oh-my-zsh) for git users who are not fan of f
|
||||
<img src="https://github.com/cemsbr/asciigit/blob/screenshot/screenshot.png?raw=true" width="606" height="468" alt="screenshot">
|
||||
|
||||
Features:
|
||||
- Works well in terminal or console. No need to change your font!
|
||||
- Git info:
|
||||
- Remote url, e.g. github.com/cemsbr/asciigit;
|
||||
- Relative path from git root dir;
|
||||
- Branch name;
|
||||
- Status (diverged, added, untracked, etc...).
|
||||
- Colors known to work well with solarized light (probably with other schemes, too).
|
||||
|
||||
* Works well in terminal or console. No need to change your font!
|
||||
* Git info:
|
||||
* Remote url, e.g. github.com/cemsbr/asciigit;
|
||||
* Relative path from git root dir;
|
||||
* Branch name;
|
||||
* Status (diverged, added, untracked, etc...).
|
||||
* Colors known to work well with solarized light (probably with other schemes, too).
|
||||
|
||||
See [repository](https://github.com/cemsbr/asciigit) for source and readme.
|
||||
|
||||
Author: [@cemsbr](https://github.com/cemsbr)
|
||||
|
||||
|
||||
#### dpoggi-newline-timestamp
|
||||
|
||||
Timestamp and new line based on [dpoggi](https://github.com/ohmyzsh/ohmyzsh/wiki/Themes#dpoggi) theme.
|
||||
|
||||
<img width="651" alt="2017-09-08 18 03 32" src="https://user-images.githubusercontent.com/1831308/30204562-dd033128-94c0-11e7-944c-19d7b0c18196.png">
|
||||
|
||||
|
||||
Features:
|
||||
- Timestamp
|
||||
- New line for command
|
||||
|
||||
* Timestamp
|
||||
* New line for command
|
||||
|
||||
See [repository](https://github.com/channprj/dotfiles-macOS) for [source](https://github.com/channprj/dotfiles-macOS/blob/master/sh/zsh/custom-zsh-theme/dpoggi-timestamp.zsh-theme).
|
||||
|
||||
Author: [@channprj](https://github.com/channprj)
|
||||
|
||||
|
||||
#### nothing
|
||||
|
||||
|
||||
@ -1142,6 +1174,7 @@ Repo: [https://github.com/agkozak/agkozak-zsh-prompt](https://github.com/agkozak
|
||||
Author: [@agkozak](https://github.com/agkozak)
|
||||
|
||||
#### rainbow-theme
|
||||
|
||||
|
||||
|
||||
Repo: [https://github.com/nivaca/rainbow-theme](https://github.com/nivaca/rainbow-theme)
|
||||
@ -1149,6 +1182,7 @@ Repo: [https://github.com/nivaca/rainbow-theme](https://github.com/nivaca/rainbo
|
||||
Author: [@nivaca](https://github.com/nivaca)
|
||||
|
||||
---
|
||||
|
||||
#### Zeroastro Theme
|
||||
|
||||
|
||||
@ -1160,6 +1194,7 @@ Repo: [https://github.com/zeroastro/zeroastro-zsh-theme](https://github.com/zero
|
||||
Author: [@zeroastro](https://github.com/zeroastro)
|
||||
|
||||
---
|
||||
|
||||
### Kayid Theme
|
||||
|
||||
|
||||
@ -1168,6 +1203,7 @@ See [repo](https://github.com/AmrMKayid/KayidmacOS/blob/master/kayid.zsh-theme)
|
||||
Author: [@AmrMKayid](https://github.com/AmrMKayid)
|
||||
|
||||
---
|
||||
|
||||
### Shayan ZSH Theme
|
||||
|
||||
|
||||
@ -1179,6 +1215,7 @@ Repo: [https://github.com/shayanh/shayan-zsh-theme](https://github.com/shayanh/s
|
||||
Author: [@shayanh](https://github.com/shayanh)
|
||||
|
||||
---
|
||||
|
||||
### FunkyBerlin Theme
|
||||
|
||||
|
||||
@ -1190,6 +1227,7 @@ Repo: [https://github.com/Ottootto2010/funkyberlin-zsh-theme](https://github.com
|
||||
Author: [@Ottootto2010](https://github.com/Ottootto2010/funkyberlin-zsh-theme)
|
||||
|
||||
---
|
||||
|
||||
### RobbyRussell-WIP Theme
|
||||
|
||||
|
||||
@ -1201,6 +1239,7 @@ Repo: https://github.com/ecbrodie/robbyrussell-WIP-theme
|
||||
Author: [@ecbrodie](https://github.com/ecbrodie)
|
||||
|
||||
---
|
||||
|
||||
### McQuen Theme
|
||||
|
||||
|
||||
@ -1211,7 +1250,7 @@ Repo: [https://gist.github.com/ryanpcmcquen/150cf9a66bca2463e5660cafed3e1000](ht
|
||||
|
||||
Author: [@ryanpcmcquen](https://github.com/ryanpcmcquen)
|
||||
|
||||
----
|
||||
---
|
||||
|
||||
#### sm
|
||||
|
||||
@ -1223,7 +1262,7 @@ source: [Repo](https://github.com/blyndusk/sm-theme) for source.
|
||||
|
||||
author: [@blyndusk](https://github.com/blyndusk)
|
||||
|
||||
----
|
||||
---
|
||||
|
||||
#### minimal2
|
||||
|
||||
@ -1329,7 +1368,6 @@ Author: [@sudo-HackerMan](https://github.com/sudo-HackerMan)
|
||||
|
||||
Original: [@RainyDayMedia](https://github.com/RainyDayMedia/oh-my-zsh-poncho)
|
||||
|
||||
|
||||
#### None Theme
|
||||
|
||||
|
||||
@ -1340,11 +1378,10 @@ Source: File `none.zsh-theme` containing only the line `PROMPT=""`.
|
||||
|
||||
Author: [@catleeball](https://github.com/catleeball)
|
||||
|
||||
|
||||
|
||||
|
||||
#### fishbone++
|
||||
|
||||
##### Features:
|
||||
|
||||
* emoji git status :)
|
||||
* fault return indicator
|
||||
* various customization
|
||||
@ -1356,11 +1393,14 @@ Author: [@catleeball](https://github.com/catleeball)
|
||||
|
||||
Source: [fishbone++](https://github.com/EYH0602/Fishbonepp)
|
||||
Author: [@EYH0602](https://github.com/EYH0602)
|
||||
|
||||
#### Ohio2's themes!
|
||||
|
||||
##### Features:
|
||||
|
||||
* Simple
|
||||
* One based on dallas
|
||||
* a whole collection.
|
||||
* One based on dallas
|
||||
* a whole collection.
|
||||
* Easy to customize
|
||||
* Time marker (ohio2, not ybl)
|
||||
* Git marker.
|
||||
@ -1368,7 +1408,7 @@ Author: [@EYH0602](https://github.com/EYH0602)
|
||||
Themes:[Ohio2's themes repo](https://github.com/Ohio2/dotfiles-ohio2/tree/master/.oh-my-zsh/themes)
|
||||
|
||||
|
||||
***
|
||||
---
|
||||
|
||||
<br/>
|
||||
<h3 align="center"><a href="https://github.com/ice-bear-forever/bubblegum-zsh">bubblegum</a></h3>
|
||||
@ -1379,6 +1419,7 @@ Themes:[Ohio2's themes repo](https://github.com/Ohio2/dotfiles-ohio2/tree/master
|
||||
</p></a>
|
||||
|
||||
##### features:
|
||||
|
||||
* a triangular glyph and your working directory, nothing more
|
||||
* a [matching theme](https://github.com/ice-bear-forever/hyper-bubblegum) for [Hyper](http://hyper.is) terminal
|
||||
|
||||
@ -1386,7 +1427,7 @@ repository: [bubblegum-zsh](https://github.com/ice-bear-forever/bubblegum-zsh/)
|
||||
|
||||
author: [@ice-bear-forever](https://github.com/ice-bear-forever/)
|
||||
|
||||
***
|
||||
---
|
||||
|
||||
<br/>
|
||||
<h3 align="center"><a href="https://github.com/tigerjz32/kube-zsh-theme">kube</a></h3>
|
||||
@ -1397,18 +1438,21 @@ author: [@ice-bear-forever](https://github.com/ice-bear-forever/)
|
||||
</p></a>
|
||||
|
||||
##### features:
|
||||
- shows the current time
|
||||
- shows current kubectl context
|
||||
- shows current dir
|
||||
- shows current Git branch
|
||||
- shows an arrow to differentiate input vs prompt
|
||||
- uses different colors for readability
|
||||
|
||||
* shows the current time
|
||||
|
||||
* shows current kubectl context
|
||||
* shows current dir
|
||||
* shows current Git branch
|
||||
* shows an arrow to differentiate input vs prompt
|
||||
* uses different colors for readability
|
||||
|
||||
repository: [kube-zsh-theme](https://github.com/tigerjz32/kube-zsh-theme/)
|
||||
|
||||
author: [@tigerjz32](https://github.com/tigerjz32)
|
||||
|
||||
#### shini
|
||||
|
||||
|
||||
|
||||
A simple zsh theme. With your average time, exit status, user@host, directory and git branch, you can just install and relax.
|
||||
|
||||
11
FAQ.md
11
FAQ.md
@ -1,6 +1,6 @@
|
||||
_If you don't find what you're looking for, and you think it should be covered by the FAQ, please [open a new issue](https://github.com/ohmyzsh/ohmyzsh/issues/new?title=FAQ:%20) with what you think should be here._
|
||||
|
||||
<!-- TOC depthFrom:2 -->
|
||||
<!-- TOC depthfrom:2 -->
|
||||
|
||||
- [Definitions](#definitions)
|
||||
- [What is Oh My Zsh and what does it have to do with zsh?](#what-is-oh-my-zsh-and-what-does-it-have-to-do-with-zsh)
|
||||
@ -11,7 +11,7 @@ _If you don't find what you're looking for, and you think it should be covered b
|
||||
- [What Zsh is not](#what-zsh-is-not)
|
||||
- [How do I...?](#how-do-i)
|
||||
- [How do I install Zsh?](#how-do-i-install-zsh)
|
||||
- [How do I install Zsh on Windows?](#how-do-i-install-zsh-on-windows)
|
||||
- [How do I install Zsh on Windows?](#how-do-i-install-zsh-on-windows)
|
||||
- [How do I install Oh My Zsh?](#how-do-i-install-oh-my-zsh)
|
||||
- [How do I uninstall Oh My Zsh?](#how-do-i-uninstall-oh-my-zsh)
|
||||
- [How do I change my locale?](#how-do-i-change-my-locale)
|
||||
@ -27,7 +27,7 @@ _If you don't find what you're looking for, and you think it should be covered b
|
||||
- [Zsh errors](#zsh-errors)
|
||||
- [zsh: no matches found](#zsh-no-matches-found)
|
||||
- [Other problems](#other-problems)
|
||||
- [`kill-word` or `backward-kill-word` do / don't delete a symbol (`WORDCHARS`)](#kill-word-or-backward-kill-word-do--dont-delete-a-symbol-wordchars)
|
||||
- [kill-word or backward-kill-word do / don't delete a symbol WORDCHARS](#kill-word-or-backward-kill-word-do--dont-delete-a-symbol-wordchars)
|
||||
|
||||
<!-- /TOC -->
|
||||
|
||||
@ -82,12 +82,11 @@ You can't install Zsh directly on Windows. As a reminder, Oh My Zsh needs Zsh in
|
||||
|
||||
To use Zsh on Windows, you need Windows 10 2004 or 11, and one of the following:
|
||||
|
||||
* [Cygwin](https://github.com/ohmyzsh/ohmyzsh/wiki/Installing-ZSH#cygwin)
|
||||
* [WSL](https://github.com/ohmyzsh/ohmyzsh/wiki/Installing-ZSH#ubuntu-debian--derivatives-windows-10-wsl--native-linux-kernel-with-windows-10-build-1903) (note that this requires you to first [install WSL](https://docs.microsoft.com/en-us/windows/wsl/install))
|
||||
- [Cygwin](https://github.com/ohmyzsh/ohmyzsh/wiki/Installing-ZSH#cygwin)
|
||||
- [WSL](https://github.com/ohmyzsh/ohmyzsh/wiki/Installing-ZSH#ubuntu-debian--derivatives-windows-10-wsl--native-linux-kernel-with-windows-10-build-1903) (note that this requires you to first [install WSL](https://docs.microsoft.com/en-us/windows/wsl/install))
|
||||
|
||||
If you're running earlier versions of Windows, you can't install it at all. You'll need a virtual machine, or a proper Linux install.
|
||||
|
||||
|
||||
#### How do I install Oh My Zsh?
|
||||
|
||||
Please follow the project's README instructions for a [basic installation](https://github.com/ohmyzsh/ohmyzsh#basic-installation), or the [advanced instructions](https://github.com/ohmyzsh/ohmyzsh#advanced-installation) if you need to automate the installation or change some of the settings of the installer.
|
||||
|
||||
@ -1,5 +1,6 @@
|
||||
|
||||
***
|
||||
|
||||
## Zsh?
|
||||
|
||||
Oh-My-Zsh is a framework for [Zsh](http://www.zsh.org), the Z shell.
|
||||
@ -15,16 +16,22 @@ Oh-My-Zsh is a framework for [Zsh](http://www.zsh.org), the Z shell.
|
||||
|
||||
If necessary, follow these steps to install Zsh:
|
||||
|
||||
1. There are two main ways to install Zsh
|
||||
- with the package manager of your choice, _e.g._ `sudo apt install zsh` (see [below for more examples](#how-to-install-zsh-on-many-platforms))
|
||||
- from [source](http://zsh.sourceforge.net/Arc/source.html), following
|
||||
[instructions from the Zsh FAQ](http://zsh.sourceforge.net/FAQ/zshfaq01.html#l7)
|
||||
1. There are two main ways to install Zsh:
|
||||
|
||||
- With the package manager of your choice, _e.g._ `sudo apt install zsh` (see [below for more examples](#how-to-install-zsh-on-many-platforms))
|
||||
- From [source](http://zsh.sourceforge.net/Arc/source.html), following [the instructions from the Zsh FAQ](http://zsh.sourceforge.net/FAQ/zshfaq01.html#l7).
|
||||
|
||||
2. Verify installation by running `zsh --version`. Expected result: `zsh 5.0.8` or more recent.
|
||||
|
||||
3. Make it your default shell: `chsh -s $(which zsh)`
|
||||
- Note that this will not work if Zsh is not in your authorized shells list (`/etc/shells`)
|
||||
|
||||
- Note that this will not work if Zsh is not in your authorized shells list (`/etc/shells`)
|
||||
or if you don't have permission to use `chsh`. If that's the case [you'll need to use a different procedure](https://www.google.com/search?q=zsh+default+without+chsh).
|
||||
|
||||
4. Log out and log back in again to use your new default shell.
|
||||
|
||||
5. Test that it worked with `echo $SHELL`. Expected result: `/bin/zsh` or similar.
|
||||
|
||||
6. Test with `$SHELL --version`. Expected result: 'zsh 5.8' or similar
|
||||
|
||||
## How to install zsh on many platforms
|
||||
@ -36,16 +43,20 @@ If necessary, follow these steps to install Zsh:
|
||||
```sh
|
||||
brew install zsh
|
||||
```
|
||||
|
||||
To set zsh as your default shell, execute the following assuming a default install of Homebrew
|
||||
|
||||
> Recent Mac OS versions:
|
||||
```
|
||||
chsh -s /usr/local/bin/zsh
|
||||
```
|
||||
> Mac OS **High Sierra** and before:
|
||||
```
|
||||
chsh -s /bin/zsh
|
||||
```
|
||||
- Recent macOS versions:
|
||||
|
||||
```sh
|
||||
chsh -s /usr/local/bin/zsh
|
||||
```
|
||||
|
||||
- macOS **High Sierra** and older:
|
||||
|
||||
```sh
|
||||
chsh -s /bin/zsh
|
||||
```
|
||||
|
||||
Assuming you have [Homebrew](http://brew.sh/) installed. If not, most versions of
|
||||
**macOS** ship zsh by default, but it's normally an older version. Alternatively, you may
|
||||
@ -62,10 +73,10 @@ apt install zsh
|
||||
```
|
||||
|
||||
If you don't have `apt`, the recommended package manager for end users
|
||||
[ [1] ](http://askubuntu.com/a/446484)
|
||||
[ [2] ](http://askubuntu.com/a/775264)
|
||||
[ [3] ](https://help.ubuntu.com/lts/serverguide/apt.html)
|
||||
[ [4] ](http://www.howtogeek.com/234583/simplify-command-line-package-management-with-apt-instead-of-apt-get/)
|
||||
[[1]](http://askubuntu.com/a/446484)
|
||||
[[2]](http://askubuntu.com/a/775264)
|
||||
[[3]](https://help.ubuntu.com/lts/serverguide/apt.html)
|
||||
[[4]](http://www.howtogeek.com/234583/simplify-command-line-package-management-with-apt-instead-of-apt-get/)
|
||||
, you can try `apt-get` or `aptitude`.
|
||||
|
||||
[Other distributions that apply](https://en.wikipedia.org/wiki/List_of_Linux_distributions#Debian-based) include:
|
||||
@ -94,32 +105,46 @@ xbps-install zsh
|
||||
```sh
|
||||
dnf install zsh
|
||||
```
|
||||
|
||||
### OpenBSD
|
||||
|
||||
To install the package:
|
||||
|
||||
```sh
|
||||
pkg_add zsh
|
||||
```
|
||||
|
||||
### FreeBSD
|
||||
|
||||
To install the package:
|
||||
|
||||
```sh
|
||||
pkg install zsh
|
||||
```
|
||||
|
||||
To install the port:
|
||||
|
||||
```sh
|
||||
cd /usr/ports/shells/zsh/ && make install clean
|
||||
```
|
||||
|
||||
To reduce memory usage, optionally enable zsh-mem options with
|
||||
|
||||
|
||||
|
||||
```sh
|
||||
make config
|
||||
```
|
||||
|
||||
before running "make install".
|
||||
|
||||
### Centos/RHEL
|
||||
|
||||
```sh
|
||||
sudo yum update && sudo yum -y install zsh
|
||||
```
|
||||
|
||||
### Cygwin
|
||||
|
||||
Install the zsh package using the installer. Unfortunately Cygwin doesn't have a standard command line interface. You could, however, setup [apt-cyg](https://github.com/kou1okada/apt-cyg) and install zsh as follows:
|
||||
|
||||
```sh
|
||||
@ -130,13 +155,17 @@ The easiest way to change the default shell is to set your SHELL user environmen
|
||||
|
||||
*Alternatively:*
|
||||
Open Cygwin (in BASH) then type:
|
||||
|
||||
```sh
|
||||
sudo nano ~/.bashrc
|
||||
```
|
||||
|
||||
Once the .bashrc file is open, add this line to the very top:
|
||||
|
||||
```sh
|
||||
exec zsh
|
||||
```
|
||||
|
||||
Close and save the file.
|
||||
Close and reopen Cygwin.
|
||||
It will execute the command every time you load the terminal and run your zsh shell.
|
||||
@ -148,44 +177,59 @@ eopkg it zsh
|
||||
```
|
||||
|
||||
### Funtoo/Gentoo
|
||||
|
||||
```sh
|
||||
emerge app-shells/zsh
|
||||
```
|
||||
|
||||
### Alpine Linux
|
||||
|
||||
```sh
|
||||
apk add zsh
|
||||
```
|
||||
|
||||
### MSYS2
|
||||
|
||||
```sh
|
||||
pacman -S zsh
|
||||
```
|
||||
|
||||
### Termux (Android)
|
||||
|
||||
Termux is an terminal emulator for Android but has modern feature like Debian and Ubuntu (Termux has Bash shell and Busybox GNU-like programs). For the package manager, Termux using an Debian/Ubuntu package manager, APT.
|
||||
To install the package, run this command:
|
||||
|
||||
```sh
|
||||
pkg install zsh
|
||||
```
|
||||
|
||||
The command looks like FreeBSD package manager (`pkg`). Or you can run this command:
|
||||
|
||||
```sh
|
||||
apt update && apt upgrade
|
||||
apt install zsh
|
||||
```
|
||||
|
||||
To set zsh as your default shell, run this command:
|
||||
|
||||
```sh
|
||||
chsh -s /data/data/com.termux/files/usr/bin/zsh
|
||||
```
|
||||
|
||||
Or:
|
||||
|
||||
```sh
|
||||
chsh -s $(which zsh)
|
||||
```
|
||||
|
||||
### KISS Linux
|
||||
|
||||
To install zsh, you must add the [community](https://github.com/kiss-community/repo-community/) repo to your `$KISS_PATH`.
|
||||
|
||||
```sh
|
||||
kiss b zsh && kiss i zsh
|
||||
```
|
||||
|
||||
### Add yours
|
||||
|
||||
If you know a platform that is not covered, edit this page and add it!
|
||||
130
Testimonials.md
130
Testimonials.md
@ -1,45 +1,131 @@
|
||||
Please share your thoughts on Oh My Zsh... they might help influence others to use and/or avoid it like the black plague.
|
||||
|
||||
"oh-my-zsh is probably the only good thing I've ever done with my life." -- [[robbyrussell|https://github.com/robbyrussell]]
|
||||
> **oh-my-zsh is probably the only good thing I've ever done with my life.**
|
||||
>
|
||||
> -- **[@robbyrussell](https://github.com/robbyrussell)**
|
||||
|
||||
"oh-my-zsh is among the first things i install on any new machine I set up. It's as necessary as the shell itself." -- [[imeyer|https://github.com/imeyer]]
|
||||
----
|
||||
|
||||
"oh-my-zsh can sometimes get a bit in the way, and it needs more polish, but generally it turns zsh from something which takes a lot of research and config fiddling into something that works pleasantly out of the box, and makes tweaking more straightforward" -- [[Dieterbe|https://github.com/dieterbe]]
|
||||
> oh-my-zsh is among the first things i install on any new machine I set up. It's as necessary as the shell itself.
|
||||
>
|
||||
> -- [@imeyer](https://github.com/imeyer)
|
||||
|
||||
"I honestly don't even like using zsh without oh-my-zsh" -- [[mrjones2014|https://github.com/mrjones2014]]
|
||||
----
|
||||
|
||||
"This project is so much more than a sane set of defaults for zsh. It is a major hub of plugin development! The fact that everything is all nicely packaged as a project on github is very nice indeed. Zsh is an amazing shell, but it seems to suffer a lack of guides on how to use it. By checking out oh-my-zsh you get a really nice set of examples in which you can learn zsh" -- [[Ksira|https://github.com/ksira]]
|
||||
> oh-my-zsh can sometimes get a bit in the way, and it needs more polish, but generally it turns zsh from something which takes a lot of research and config fiddling into something that works pleasantly out of the box, and makes tweaking more straightforward
|
||||
>
|
||||
> -- [@Dieterbe](https://github.com/dieterbe)
|
||||
|
||||
"oh-my-zsh: your life in a shell" -- [[fox|https://github.com/volpino]]
|
||||
----
|
||||
|
||||
"oh-my-zsh is probably one of the most fun open source projects to yell the name out loud." -- [[secondplanet|https://github.com/secondplanet]]
|
||||
> I honestly don't even like using zsh without oh-my-zsh
|
||||
>
|
||||
> -- [@mrjones2014](https://github.com/mrjones2014)
|
||||
|
||||
"oh-my-zsh makes me 300 milliseconds more efficient per command... I like it!" -- [[michielmulders|https://github.com/michielmulders]]
|
||||
----
|
||||
|
||||
"oh-my-zsh is now mandatory on all my dev servers, it makes bash look boring!" -- [[digital006|https://github.com/digital006]]
|
||||
> This project is so much more than a sane set of defaults for zsh. It is a major hub of plugin development! The fact that everything is all nicely packaged as a project on github is very nice indeed. Zsh is an amazing shell, but it seems to suffer a lack of guides on how to use it. By checking out oh-my-zsh you get a really nice set of examples in which you can learn zsh
|
||||
>
|
||||
> -- [@Ksira](https://github.com/ksira)
|
||||
|
||||
"today i installed @ohmyzsh on my machine. after 10 minutes of use, i decided that there is no way back to bash =)" -- [[patbaumgartner|https://twitter.com/patbaumgartner/status/95954168531001344]]
|
||||
----
|
||||
|
||||
"if a shell can make disruptive progress, zsh does." -- [[troyd|https://twitter.com/#!/troyd/status/96330785086373888]]
|
||||
> oh-my-zsh: your life in a shell
|
||||
>
|
||||
> -- [@fox](https://github.com/volpino)
|
||||
|
||||
"My terminal is the happiest terminal on the whole earth since I have installed Zsh and Oh My Zsh!" -- [[semahawk|https://github.com/semahawk]]
|
||||
----
|
||||
|
||||
"ZSH, by default, is a pain to setup. Thanks oh-my-zsh for hand-holding noobs into this wonderful shell!" -- [[vikred|https://github.com/vikas-reddy]]
|
||||
> oh-my-zsh is probably one of the most fun open source projects to yell the name out loud.
|
||||
>
|
||||
> -- [@secondplanet](https://github.com/secondplanet)
|
||||
|
||||
"I've just started to use ZSH and with oh-my-zsh, my life just got better!" -- [[vinnx|https://github.com/vinhnx]]
|
||||
----
|
||||
|
||||
"thanks to anyone who helped make the firework you call zsh!" --[[awesoham|http://sohamchowdhury.com/]]
|
||||
> oh-my-zsh makes me 300 milliseconds more efficient per command... I like it!
|
||||
>
|
||||
> -- [@michielmulders](https://github.com/michielmulders)
|
||||
|
||||
"Oh-my-zsh 很贴心，让 Zsh 配置变得更加简单，它让我享受到了比以往更加美丽的终端！" --[[tuhaihe|http://tuhaihe.com/]]
|
||||
----
|
||||
|
||||
"I just can't imagine not using oh-my-zsh. I can believe I won't have to mess around with `.bashrc` again" --[[davblayn|https://github.com/davblayn]]
|
||||
> oh-my-zsh is now mandatory on all my dev servers, it makes bash look boring!
|
||||
>
|
||||
> -- [@digital006](https://github.com/digital006)
|
||||
|
||||
".i mi noi lojbo cu prami la'o gy oh-my-zsh gy i'esai" --[[DavidMikeSimon|https://github/DavidMikeSimon]]
|
||||
----
|
||||
|
||||
"This is the one for me." --[[SysVoid|https://github.com/SysVoid]]
|
||||
> today i installed @ohmyzsh on my machine. after 10 minutes of use, i decided that there is no way back to bash =)
|
||||
>
|
||||
> -- [@patbaumgartner](https://twitter.com/patbaumgartner/status/95954168531001344)
|
||||
|
||||
"As a shell newbie, oh-my-zsh is my lighthouse. As I drown in the shell-sea at least I know where the mainland is!" --[[V-J-P|https://github.com/V-J-P]]
|
||||
----
|
||||
|
||||
"My mouth dropped the first time I saw my new terminal with oh-my-zsh. I teach web development to students at a bootcamp. When students are struggling with the terminal, I tell them to install oh-my-zsh and struggling students start understanding it better. Its amazing themes can tell the students what directory they are in right way and what branch too" --[[besteman|https://github.com/besteman]]
|
||||
> if a shell can make disruptive progress, zsh does.
|
||||
>
|
||||
> -- [@troyd](https://twitter.com/#!/troyd/status/96330785086373888)
|
||||
|
||||
"J'utilise OMZ depuis que j'ai commence a developper en C et ca m'a sauve la vie bien des fois ! Il est pour moi impensable d'utilser un shell sans OMZ! --[[Seluj78|https://github.com/seluj78]]
|
||||
----
|
||||
|
||||
> My terminal is the happiest terminal on the whole earth since I have installed Zsh and Oh My Zsh!
|
||||
>
|
||||
> -- [@semahawk](https://github.com/semahawk)
|
||||
|
||||
----
|
||||
|
||||
> ZSH, by default, is a pain to setup. Thanks oh-my-zsh for hand-holding noobs into this wonderful shell!
|
||||
>
|
||||
> -- [@vikred](https://github.com/vikas-reddy)
|
||||
|
||||
----
|
||||
|
||||
> I've just started to use ZSH and with oh-my-zsh, my life just got better!
|
||||
>
|
||||
> -- [@vinnx](https://github.com/vinhnx)
|
||||
|
||||
----
|
||||
|
||||
> thanks to anyone who helped make the firework you call zsh!
|
||||
>
|
||||
> -- [@awesoham](http://sohamchowdhury.com/)
|
||||
|
||||
----
|
||||
|
||||
> Oh-my-zsh 很贴心，让 Zsh 配置变得更加简单，它让我享受到了比以往更加美丽的终端！
|
||||
>
|
||||
> -- [@tuhaihe](http://tuhaihe.com/)
|
||||
|
||||
----
|
||||
|
||||
> I just can't imagine not using oh-my-zsh. I can believe I won't have to mess around with `.bashrc` again
|
||||
>
|
||||
> -- [@davblayn](https://github.com/davblayn)
|
||||
|
||||
----
|
||||
|
||||
> .i mi noi lojbo cu prami la'o gy oh-my-zsh gy i'esai
|
||||
>
|
||||
> -- [@DavidMikeSimon](https://github/DavidMikeSimon)
|
||||
|
||||
----
|
||||
|
||||
> This is the one for me.
|
||||
>
|
||||
> -- [@SysVoid](https://github.com/SysVoid)
|
||||
|
||||
----
|
||||
|
||||
> As a shell newbie, oh-my-zsh is my lighthouse. As I drown in the shell-sea at least I know where the mainland is!
|
||||
>
|
||||
> -- [@V-J-P](https://github.com/V-J-P)
|
||||
|
||||
----
|
||||
|
||||
> My mouth dropped the first time I saw my new terminal with oh-my-zsh. I teach web development to students at a bootcamp. When students are struggling with the terminal, I tell them to install oh-my-zsh and struggling students start understanding it better. Its amazing themes can tell the students what directory they are in right way and what branch too
|
||||
>
|
||||
> -- [@besteman](https://github.com/besteman)
|
||||
|
||||
----
|
||||
|
||||
> J'utilise OMZ depuis que j'ai commence a developper en C et ca m'a sauve la vie bien des fois ! Il est pour moi impensable d'utilser un shell sans OMZ!
|
||||
>
|
||||
> -- [@Seluj78](https://github.com/seluj78)
|
||||
|
||||
217
Themes.md
217
Themes.md
@ -7,22 +7,26 @@ If you do not want any theme enabled, just set `ZSH_THEME` to blank: `ZSH_THEME=
|
||||
|
||||
Here is a collection of screenshots and descriptions of themes that have been contributed to Oh My Zsh. There are some missing from this page. If you want to add or edit descriptions, see the [format description](#theme-description-format) at the bottom of this page.
|
||||
|
||||
## The Themes
|
||||
## Themes
|
||||
|
||||
### robbyrussell
|
||||
*the (default) that Robby uses*
|
||||
|
||||
*The default that Robby Russell uses.*
|
||||
|
||||
|
||||
|
||||
------------------------------------
|
||||
----
|
||||
|
||||
The rest of the themes, in alphabetical order:
|
||||
|
||||
## A
|
||||
|
||||
### af-magic
|
||||
|
||||
|
||||
|
||||
### afowler
|
||||
|
||||
|
||||
|
||||
### agnoster
|
||||
@ -34,221 +38,284 @@ The rest of the themes, in alphabetical order:
|
||||
Shown with [Solarized Dark colorscheme](http://ethanschoonover.com/solarized) and Powerline-patched Meslo 14pt in [iTerm 2](http://www.iterm2.com/).
|
||||
|
||||
Additional setup:
|
||||
|
||||
- Install one of the [patched fonts from Vim-Powerline](https://github.com/powerline/fonts) or [patch your own](https://github.com/powerline/fontpatcher) for the special characters.
|
||||
- *Optionally* set `DEFAULT_USER` to your regular username followed by prompt_context(){} in `~/.zshrc` to hide the “user@hostname” info when you’re logged in as yourself on your local machine.
|
||||
|
||||
### alanpeabody
|
||||
|
||||
|
||||
|
||||
### amuse
|
||||
|
||||
|
||||
|
||||
Shown in the screenshot with tmux and the [powerline plugin](https://github.com/powerline/powerline) (you might need to install one of the [patched powerline fonts](https://github.com/powerline/fonts) for it to look the same).
|
||||
|
||||
### apple
|
||||
|
||||
|
||||
|
||||
### arrow
|
||||
|
||||
|
||||
|
||||
### aussiegeek
|
||||
|
||||
|
||||
|
||||
### avit
|
||||
|
||||
|
||||
|
||||
### awesomepanda
|
||||
|
||||
|
||||
|
||||
|
||||
## B
|
||||
|
||||
### bira
|
||||
|
||||
|
||||
|
||||
### blinks
|
||||
|
||||
|
||||
|
||||
### bureau
|
||||
|
||||
|
||||
|
||||
To use: In the right prompt you see git status and (if you use nvm) the Node.js version.
|
||||
|
||||
|
||||
## C
|
||||
|
||||
### candy
|
||||
|
||||
|
||||
|
||||
### clean
|
||||
|
||||
|
||||
|
||||
### cloud
|
||||
|
||||
|
||||
|
||||
### crcandy
|
||||
|
||||
|
||||
|
||||
### crunch
|
||||
|
||||
|
||||
|
||||
### cypher
|
||||
|
||||
|
||||
|
||||
|
||||
## D
|
||||
|
||||
### dallas
|
||||
|
||||
|
||||
|
||||
### darkblood
|
||||
|
||||
|
||||
|
||||
### daveverwer
|
||||
|
||||
|
||||
|
||||
### dieter
|
||||
|
||||
|
||||
|
||||
### dogenpunk
|
||||
|
||||
|
||||
|
||||
### dpoggi
|
||||
|
||||
|
||||
|
||||
### dst
|
||||
|
||||
|
||||
|
||||
### dstufft
|
||||
|
||||
|
||||
|
||||
### duellj
|
||||
|
||||
|
||||
|
||||
|
||||
## E
|
||||
|
||||
### eastwood
|
||||
|
||||
|
||||
|
||||
### edvardm
|
||||
|
||||
|
||||
|
||||
### emotty
|
||||
|
||||
|
||||
|
||||
### essembeh
|
||||
|
||||
|
||||
|
||||
### evan
|
||||
|
||||
|
||||
|
||||
|
||||
## F
|
||||
|
||||
### fino-time
|
||||
|
||||
|
||||
|
||||
### fino
|
||||
|
||||
|
||||
|
||||
### fishy
|
||||
|
||||
|
||||
|
||||
The fish shell prompt with git support
|
||||
|
||||
### flazz
|
||||
|
||||
|
||||
|
||||
Has git and vi-command mode support (when enabled)
|
||||
|
||||
### fletcherm
|
||||
|
||||
|
||||
|
||||
### fox
|
||||
|
||||
|
||||
|
||||
### frisk
|
||||
|
||||
|
||||
|
||||
### frontcube
|
||||
|
||||
|
||||
|
||||
### funky
|
||||
|
||||
|
||||
|
||||
It’s funky…
|
||||
|
||||
### fwalch
|
||||
|
||||
|
||||
|
||||
|
||||
# G
|
||||
|
||||
### gallifrey
|
||||
|
||||
|
||||
|
||||
### gallois
|
||||
|
||||
|
||||
|
||||
### garyblessington
|
||||
|
||||
|
||||
|
||||
### gentoo
|
||||
|
||||
|
||||
|
||||
### geoffgarside
|
||||
|
||||
|
||||
|
||||
### gianu
|
||||
|
||||
|
||||
|
||||
### gnzh
|
||||
|
||||
|
||||
|
||||
### gozilla
|
||||
|
||||
|
||||
|
||||
|
||||
## H
|
||||
|
||||
### half-life
|
||||
|
||||
|
||||
|
||||
### humza
|
||||
|
||||
|
||||
|
||||
|
||||
# I
|
||||
|
||||
### imajes
|
||||
|
||||
|
||||
|
||||
### intheloop
|
||||
|
||||
|
||||
|
||||
### itchy
|
||||
|
||||
|
||||
|
||||
|
||||
# J
|
||||
|
||||
### jaischeema
|
||||
|
||||
|
||||
|
||||
### jbergantine
|
||||
|
||||
|
||||
|
||||
### jispwoso
|
||||
|
||||
|
||||
|
||||
### jnrowe
|
||||
|
||||
|
||||
|
||||
### jonathan
|
||||
|
||||
|
||||
|
||||
### josh
|
||||
|
||||
|
||||
|
||||
### jreese
|
||||
|
||||
|
||||
|
||||
### jtriley
|
||||
|
||||
|
||||
|
||||
### juanghurtado
|
||||
|
||||
|
||||
|
||||
### junkfood
|
||||
@ -259,237 +326,300 @@ It’s funky…
|
||||
|
||||
[More Info](http://www.tylercipriani.com/2012/12/18/zsh-prompt-customization.html)
|
||||
|
||||
|
||||
## K
|
||||
|
||||
### kafeitu
|
||||
|
||||
|
||||
|
||||
### kardan
|
||||
|
||||
|
||||
|
||||
### kennethreitz
|
||||
|
||||
|
||||
|
||||
### kolo
|
||||
|
||||
|
||||
|
||||
### kphoen
|
||||
|
||||
|
||||
|
||||
|
||||
# L
|
||||
|
||||
### lambda
|
||||
|
||||
|
||||
|
||||
### linuxonly
|
||||
|
||||
|
||||
|
||||
(As the name states, this only works on Linux)
|
||||
|
||||
### lukerandall
|
||||
|
||||
|
||||
|
||||
|
||||
## M
|
||||
|
||||
### macovsky
|
||||
|
||||
|
||||
|
||||
### maran
|
||||
|
||||
|
||||
|
||||
### mgutz
|
||||
|
||||
|
||||
|
||||
### mh
|
||||
|
||||
|
||||
|
||||
### michelebologna
|
||||
|
||||
|
||||
|
||||
### mikeh
|
||||
|
||||
|
||||
|
||||
### miloshadzic
|
||||
|
||||
|
||||
|
||||
### minimal
|
||||
|
||||
|
||||
|
||||
### mortalscumbag
|
||||
|
||||
|
||||
|
||||
Also tells you when logged in over ssh
|
||||
|
||||
### mrtazz
|
||||
|
||||
|
||||
|
||||
### murilasso
|
||||
|
||||
|
||||
|
||||
### muse
|
||||
|
||||
|
||||
|
||||
|
||||
## N
|
||||
|
||||
### nanotech
|
||||
|
||||
|
||||
|
||||
### nebirhos
|
||||
|
||||
|
||||
|
||||
### nicoulaj
|
||||
|
||||
|
||||
|
||||
### norm
|
||||
|
||||
|
||||
|
||||
|
||||
## O
|
||||
|
||||
### obraun
|
||||
|
||||
|
||||
|
||||
|
||||
## P
|
||||
|
||||
### peepcode
|
||||
|
||||
|
||||
|
||||
### philips
|
||||
|
||||
|
||||
|
||||
### pmcgee
|
||||
|
||||
|
||||
|
||||
### pygmalion
|
||||
|
||||
|
||||
|
||||
|
||||
## R
|
||||
|
||||
### re5et
|
||||
|
||||
|
||||
|
||||
### refined
|
||||
|
||||
|
||||
|
||||
### rgm
|
||||
|
||||
|
||||
|
||||
### risto
|
||||
|
||||
|
||||
|
||||
### rixius
|
||||
|
||||
|
||||
|
||||
### rkj-repos
|
||||
|
||||
|
||||
|
||||
|
||||
## S
|
||||
|
||||
### sammy
|
||||
|
||||
|
||||
|
||||
### simonoff
|
||||
|
||||
|
||||
|
||||
### simple
|
||||
|
||||
|
||||
|
||||
### skaro
|
||||
|
||||
|
||||
|
||||
### smt
|
||||
|
||||
|
||||
|
||||
### Soliah
|
||||
|
||||
|
||||
|
||||
### sonicradish
|
||||
|
||||
|
||||
|
||||
### sorin
|
||||
|
||||
|
||||
|
||||
### sporty_256
|
||||
|
||||
|
||||
|
||||
### steeef
|
||||
|
||||
|
||||
|
||||
### strug
|
||||
|
||||
|
||||
|
||||
### sunaku
|
||||
|
||||
|
||||
|
||||
Exit status if nonzero, status & branch if git, `pwd` always.
|
||||
|
||||
### sunrise
|
||||
|
||||
|
||||
|
||||
Lightweight prompt with exit status and `git status` consistent mode line.
|
||||
|
||||
### superjarin
|
||||
|
||||
|
||||
|
||||
Git status, git branch, and ruby, all in a no muss, no fuss prompt! Works with RVM, chruby, and rbenv (just activate the corresponding plugin).
|
||||
|
||||
### suvash
|
||||
|
||||
|
||||
|
||||
Username, host, directory, git branch and rvm gemset
|
||||
|
||||
|
||||
## T
|
||||
|
||||
### takashiyoshida
|
||||
|
||||
|
||||
|
||||
### terminalparty
|
||||
|
||||
|
||||
|
||||
There is a party every day.
|
||||
|
||||
### theunraveler
|
||||
|
||||
|
||||
|
||||
Minimal, informative when it needs to be.
|
||||
|
||||
### tjkirch
|
||||
|
||||
|
||||
|
||||
Based on dst, plus a lightning bolt and return codes.
|
||||
|
||||
### tonotdo
|
||||
|
||||
|
||||
|
||||
### trapd00r
|
||||
|
||||
|
||||
|
||||
|
||||
## W
|
||||
|
||||
### wedisagree
|
||||
|
||||
|
||||
|
||||
Instructions to further customize the theme are available as comments in the theme file.
|
||||
|
||||
### wezm
|
||||
|
||||
|
||||
|
||||
### wezm+
|
||||
|
||||
|
||||
|
||||
### wuffers
|
||||
|
||||
|
||||
|
||||
|
||||
## X
|
||||
|
||||
### xiong-chiamiov
|
||||
|
||||
|
||||
|
||||
### xiong-chiamiov-plus
|
||||
|
||||
|
||||
|
||||
|
||||
## Y
|
||||
|
||||
### ys
|
||||
|
||||
|
||||
|
||||
Clean, simple, compatible and meaningful.Tested on Linux, Unix and Windows under ANSI colors.
|
||||
@ -497,40 +627,38 @@ It is recommended to use with a dark background.
|
||||
|
||||
[More info](http://blog.ysmood.org/my-ys-terminal-theme/)
|
||||
|
||||
|
||||
## Z
|
||||
|
||||
### zhann
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
----
|
||||
|
||||
## More themes
|
||||
|
||||
You can find more themes [here](https://github.com/robbyrussell/oh-my-zsh/wiki/External-themes).
|
||||
|
||||
|
||||
## (Don’t) Send us your theme! (for now)
|
||||
## (Don’t) Send us your theme! (for now)
|
||||
|
||||
We have enough themes for the time being. Please fork the project and add on in there, you can let people know how to grab it from there.
|
||||
|
||||
Or put into a Gist and add it to the [External Themes list](https://github.com/robbyrussell/oh-my-zsh/wiki/External-themes).
|
||||
|
||||
|
||||
## Theme Description Format
|
||||
|
||||
The theme descriptions in this page should contain:
|
||||
* The name of the theme
|
||||
* A screenshot
|
||||
* (Preferably in PNG format, and hosted on a GitHub issue)
|
||||
* Instructions for any configuration besides setting `ZSH_THEME` in `~/.zshrc`
|
||||
* For example, font installation, terminal color scheme configuration, or optional environment variables that affect the theme
|
||||
* Any dependencies outside Oh My Zsh
|
||||
|
||||
- The name of the theme
|
||||
- A screenshot
|
||||
- (Preferably in PNG format, and hosted on a GitHub issue)
|
||||
- Instructions for any configuration besides setting `ZSH_THEME` in `~/.zshrc`
|
||||
- For example, font installation, terminal color scheme configuration, or optional environment variables that affect the theme
|
||||
- Any dependencies outside Oh My Zsh
|
||||
|
||||
We use manually-constructed screenshots because some of the themes require additional terminal configuration to look their best, and so the code in example shell sessions can showcase the theme's features. There is also a separate collection of automatically-generated screenshots linked [at the bottom of this page](#screenshots-of-each-theme).
|
||||
|
||||
|
||||
### Uploading screenshots to GitHub
|
||||
### Uploading screenshots to GitHub
|
||||
|
||||
We host all the screenshot images on GitHub itself, to avoid external dependencies on other hosting services or URLs that might break.Please, compress images before. We use issue attachments which will get them in to githubusercontent.com. (It's also possible to store image files in a GitHub wiki itself, but this requires you to have Contributor permissions for the repo whose Wiki you're editing. The issue-attachment method can be done by anybody.)
|
||||
|
||||
@ -538,16 +666,17 @@ To upload an image to GitHub, just drag and drop it into the text area on an iss
|
||||
|
||||
For example:
|
||||
|
||||
```
|
||||
[](https://cloud.githubusercontent.com/assets/1441704/6315419/915f6ca6-ba01-11e4-95b3-2c98114b5e5c.png)
|
||||
```md
|
||||
[](https://cloud.githubusercontent.com/assets/1441704/6315419/915f6ca6-ba01-11e4-95b3-2c98114b5e5c.png)
|
||||
```
|
||||
|
||||
If you have several uploaded screenshot links you need to convert to that self-linked syntax, you can use this `sed` command on the markdown file to programmatically convert them.
|
||||
|
||||
sed 's/^!\[[a-zA-Z0-9 -]*\](\([^)]*\)) *$/[&](\1)/'
|
||||
```sh
|
||||
sed 's/^!\[[a-zA-Z0-9 -]*\](\([^)]*\)) *$/[&](\1)/'
|
||||
```
|
||||
|
||||
|
||||
## Screenshots of each Theme
|
||||
## Screenshots of each Theme
|
||||
|
||||
### Version 2019-08
|
||||
|
||||
|
||||
@ -3,7 +3,8 @@ This page is meant to describe the most common problems with oh-my-zsh and what
|
||||
### Keyboard shortcut problems
|
||||
|
||||
Example:
|
||||
```shell
|
||||
|
||||
```sh
|
||||
bindkey '^L' clear-screen
|
||||
```
|
||||
|
||||
@ -45,13 +46,15 @@ Many completion problems, including the infamous `command not found: compdef`, c
|
||||
### Other problems
|
||||
|
||||
As a last resort, if you're getting weird behavior and can't find the culprit, run the following command to enable debug mode:
|
||||
```shell
|
||||
|
||||
```sh
|
||||
zsh -xv &> >(tee ~/omz-debug.log 2>/dev/null)
|
||||
```
|
||||
|
||||
Afterwards, reproduce the behavior (_i.e._ if it's a particular command, run it), and when you're done, run `exit` to stop the debugging session. This will create a `omz-debug.log` file on your home directory, which you can upload to [gist.github.com](https://gist.github.com/) and link to it on the issue you'll open next.
|
||||
|
||||
If you only need to debug the session initialization, you can do so with the command:
|
||||
```shell
|
||||
|
||||
```sh
|
||||
zsh -xvic exit &> ~/omz-debug.log
|
||||
```
|
||||
@ -18,15 +18,19 @@ Following these guidelines while making the readme for your plugin/theme would b
|
||||
|
||||
Below is an example of how to use each header (and will be the only use of ##/h2 in abnormal circumstances).
|
||||
|
||||
___
|
||||
---
|
||||
|
||||
## This is a main subject (h2)
|
||||
|
||||
### This subject has several important sub-subjects (h3)
|
||||
|
||||
#### Some sub-subjects are so vast, they require their own sub-subjects (h4)
|
||||
|
||||
##### _Example:_ (h5)
|
||||
|
||||
###### _Quick explanation of example:_ (h6)
|
||||
|
||||
___
|
||||
---
|
||||
|
||||
## Tables
|
||||
|
||||
@ -57,6 +61,7 @@ Use hyphens `-` for defining unnumbered lists and sublists, as opposed to asteri
|
||||
Use Markdown formatting for images, **not HTML**.
|
||||
|
||||
###### _Example:_
|
||||
|
||||
```markdown
|
||||
|
||||
```
|
||||
|
||||
32
_Sidebar.md
32
_Sidebar.md
@ -2,24 +2,24 @@
|
||||
* **[[FAQ]]**
|
||||
* **[[Plugins Overview]]**
|
||||
* **Documentation**
|
||||
+ [[Installing ZSH]]
|
||||
+ [[Settings]]
|
||||
+ [[Plugins]]
|
||||
+ [[Themes]]
|
||||
+ [[Cheatsheet]]
|
||||
+ [[Customization]]
|
||||
+ [[Troubleshooting]]
|
||||
* [[Installing ZSH]]
|
||||
* [[Settings]]
|
||||
* [[Plugins]]
|
||||
* [[Themes]]
|
||||
* [[Cheatsheet]]
|
||||
* [[Customization]]
|
||||
* [[Troubleshooting]]
|
||||
* **Community**
|
||||
+ [[Articles]]
|
||||
+ [[External plugins]]
|
||||
+ [[External themes]]
|
||||
+ [[Testimonials]]
|
||||
* [[Articles]]
|
||||
* [[External plugins]]
|
||||
* [[External themes]]
|
||||
* [[Testimonials]]
|
||||
* **Contributing**
|
||||
+ [[Volunteers]]
|
||||
+ [[Design]]
|
||||
+ [[Code Style Guide]]
|
||||
+ [[Wiki Style Guide]]
|
||||
+ [[Contribution Technical Practices]]
|
||||
* [[Volunteers]]
|
||||
* [[Design]]
|
||||
* [[Code Style Guide]]
|
||||
* [[Wiki Style Guide]]
|
||||
* [[Contribution Technical Practices]]
|
||||
|
||||
------------------
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user