From aadd8c7458e3ad326f0da58a033b30275fc89f27 Mon Sep 17 00:00:00 2001 From: Daniel Miessler Date: Fri, 5 Jan 2024 19:21:48 -0800 Subject: [PATCH] Adding formatting stuff to readme. --- .../dmiessler/extract-wisdom-1.0.0/README.md | 44 +++---------------- 1 file changed, 6 insertions(+), 38 deletions(-) diff --git a/extract-wisdom/dmiessler/extract-wisdom-1.0.0/README.md b/extract-wisdom/dmiessler/extract-wisdom-1.0.0/README.md index 8d1d06a..9804a4f 100644 --- a/extract-wisdom/dmiessler/extract-wisdom-1.0.0/README.md +++ b/extract-wisdom/dmiessler/extract-wisdom-1.0.0/README.md @@ -10,8 +10,7 @@ [Description](#description) • [Installation](#installation) • -[Options](#options) • -[Example](#example) • +[Examples](#examples) • [Meta](#meta) @@ -36,50 +35,19 @@ You can install `extractwisdom` by executing this command. curl -sS https://raw.githubusercontent.com/danielmiessler/fabric/main/install.sh | bash ``` -## Configuration +## Examples -### Flags - -When calling `extractwisdom`, the following flags are available: - -- `--cmd` - - Changes the prefix of the `z` and `zi` commands. - - `--cmd j` would change the commands to (`j`, `ji`). - - `--cmd cd` would replace the `cd` command (doesn't work on Nushell / POSIX shells). -- `--hook ` - - Changes how often zoxide increments a directory's score: - | Hook | Description | - | -------- | --------------------------------- | - | `none` | Never | - | `prompt` | At every shell prompt | - | `pwd` | Whenever the directory is changed | -- `--no-cmd` - - Prevents zoxide from defining the `z` and `zi` commands. - - These functions will still be available in your shell as `__zoxide_z` and - `__zoxide_zi`, should you choose to redefine them. - -## Options - -## Example +Here are some examples of how to use `extractwisdom`. ```sh z foo # cd into highest ranked directory matching foo -z foo bar # cd into highest ranked directory matching foo and bar -z foo / # cd into a subdirectory starting with foo - -z ~/foo # z also works like a regular cd command -z foo/ # cd into relative path -z .. # cd one level up -z - # cd into previous directory - -zi foo # cd with interactive selection (using fzf) +``` -z foo # show interactive completions (zoxide v0.8.0+, bash 4.4+/fish/zsh only) +```sh +z foo bar # cd into highest ranked directory matching foo and bar ``` ## Meta - Author: Daniel Miessler - Published: January 5, 2024 - -Read more about the matching algorithm [here][algorithm-matching].