Skip to content

Commit

Permalink
Added README for ZSH functions
Browse files Browse the repository at this point in the history
  • Loading branch information
Conner.Will committed Oct 17, 2023
1 parent fb1b3e5 commit 962df85
Showing 1 changed file with 47 additions and 20 deletions.
67 changes: 47 additions & 20 deletions .config/zsh/zsh/user/functions/functions-enabled/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,12 @@ ansi-colors

## Description

Record terminal with asciinema and save to preconfigured directory

## Usage

```bash

asciinema-rec
```

---
Expand All @@ -33,11 +34,12 @@ ansi-colors

## Description

If you try to cd to a file, this will cd you to the files directory

## Usage

```bash

cd ~/.config/zsh/.zshrc
```

---
Expand All @@ -46,6 +48,7 @@ ansi-colors

## Description

When cd to a symlink, cd to the actual link destination

## Usage

Expand All @@ -59,11 +62,12 @@ ansi-colors

## Description

Change directory to config directories based on letter given after cd

## Usage

```bash

cdz
```

---
Expand All @@ -72,11 +76,12 @@ ansi-colors

## Description

Wrapper for `curl -L https://cht.sh`

## Usage

```bash

cht zsh
```

---
Expand All @@ -98,11 +103,12 @@ ansi-colors

## Description

Changes prompt to preset 'demo' prompt

## Usage

```bash

DEMOPROMPT
```

---
Expand Down Expand Up @@ -151,6 +157,7 @@ dotf --help

## Description

Downloads page from website, converts to plaintext and then speaks the contents with espeak

## Usage

Expand All @@ -164,7 +171,7 @@ dotf --help

## Description

Reset zsh - Runs exec zsh
Reloads zsh - Runs exec zsh

## Usage

Expand Down Expand Up @@ -192,6 +199,7 @@ fail2ban-client-status-all

## Description

Recursive sed

## Usage

Expand All @@ -205,11 +213,12 @@ fail2ban-client-status-all

## Description

Fuzzy finder that shows file contents

## Usage

```bash

fzfcolor
```

---
Expand All @@ -218,11 +227,12 @@ fail2ban-client-status-all

## Description

Fuzzy finder ripgrep

## Usage

```bash

fzfrg
```

---
Expand All @@ -231,11 +241,12 @@ fail2ban-client-status-all

## Description

Markdown viewer in terminal

## Usage

```bash

g README.md
```

---
Expand All @@ -257,11 +268,12 @@ fail2ban-client-status-all

## Description

Acts like git, if no subcommand is passed, it will behave as if `git status` has been run

## Usage

```bash

gi
```

---
Expand All @@ -270,11 +282,12 @@ fail2ban-client-status-all

## Description

Clones a github repo then cd into the repo directory

## Usage

```bash

gitcd https://github.com/ConnerWill/dotfiles
```

---
Expand All @@ -296,11 +309,12 @@ fail2ban-client-status-all

## Description

Returns ID of GPG key

## Usage

```bash

gpgID <NAME>
```

---
Expand Down Expand Up @@ -335,6 +349,7 @@ fail2ban-client-status-all

## Description

Formats text and URL into a clickable hyperlink

## Usage

Expand Down Expand Up @@ -374,11 +389,12 @@ fail2ban-client-status-all

## Description

Man page fuzzy finder

## Usage

```bash

manfzf
```

---
Expand All @@ -400,11 +416,12 @@ fail2ban-client-status-all

## Description

Creates a directory and cd into that directory

## Usage

```bash

mkcd ~/new
```

---
Expand Down Expand Up @@ -465,6 +482,7 @@ fail2ban-client-status-all

## Description

Replaces backslashes with forwardslashes

## Usage

Expand All @@ -478,11 +496,12 @@ fail2ban-client-status-all

## Description

Removed the current working directory you are in

## Usage

```bash

rmcwd
```

---
Expand All @@ -504,11 +523,12 @@ fail2ban-client-status-all

## Description

Shows a long list of files to be removed before removing them with approval

## Usage

```bash

rmls ~/Trash
```

---
Expand All @@ -530,11 +550,12 @@ fail2ban-client-status-all

## Description

Splits `$PATH` into multiple parts

## Usage

```bash

pathnewlines
```

---
Expand All @@ -556,6 +577,7 @@ fail2ban-client-status-all

## Description

Function to create ssh keys

## Usage

Expand Down Expand Up @@ -595,11 +617,12 @@ fail2ban-client-status-all

## Description

This function tells you that you are not in vim

## Usage

```bash

:w
```

---
Expand All @@ -621,6 +644,7 @@ fail2ban-client-status-all

## Description

Displays a preview of all toilet/figlet fonts

## Usage

Expand Down Expand Up @@ -673,11 +697,12 @@ fail2ban-client-status-all

## Description

Downloads a website with wget

## Usage

```bash

wgetmirrorwebsite "https://google.com" "$HOME/Trash"
```

---
Expand All @@ -699,6 +724,7 @@ fail2ban-client-status-all

## Description

Shows a loading bar

## Usage

Expand All @@ -725,11 +751,12 @@ fail2ban-client-status-all

## Description

Reloads zsh - runs `exec zsh`

## Usage

```bash

zshreload
```

---

0 comments on commit 962df85

Please sign in to comment.