Prettify md/yaml files

Resolved via `prettier -w .`
denisidoro · Sep 8, 2022 · 5c6da68 · 5c6da68
1 parent 9d86234
commit 5c6da68
Show file tree

Hide file tree

Showing 14 changed files with 148 additions and 137 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -1,17 +1,17 @@
 ---
 name: Bug report
 about: Create a report to help us improve
-title: ''
+title: ""
 labels: bug
-assignees: ''
-
+assignees: ""
 ---
 
 **Describe the bug**
 A clear and concise description of what the bug is.
 
 **To Reproduce**
 Steps to reproduce the behavior:
+
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
@@ -24,8 +24,9 @@ A clear and concise description of what you expected to happen.
 If applicable, add screenshots to help explain your problem.
 
 **Versions:**
- - OS: [e.g. macOS, WSL ubuntu, ubuntu]
- - Shell Version [replace this text with the output of `sh --version`]
+
+- OS: [e.g. macOS, WSL ubuntu, ubuntu]
+- Shell Version [replace this text with the output of `sh --version`]
 
 **Additional context**
 Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -1,10 +1,9 @@
 ---
 name: Feature request
 about: Suggest an idea for this project
-title: ''
+title: ""
 labels: new feature
-assignees: ''
-
+assignees: ""
 ---
 
 **Is your feature request related to a problem? Please describe.**

diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -1,7 +1,7 @@
 version: 2
 updates:
-- package-ecosystem: cargo
-  directory: "/"
-  schedule:
-    interval: weekly
-  open-pull-requests-limit: 10
+  - package-ecosystem: cargo
+    directory: "/"
+    schedule:
+      interval: weekly
+    open-pull-requests-limit: 10
diff --git a/.github/workflows/cd.yml b/.github/workflows/cd.yml
@@ -3,10 +3,9 @@ name: Publish
 on:
   push:
     tags:
-      - '*'
+      - "*"
 
 jobs:
-
   binary:
     name: Publish ${{ matrix.target }}
     runs-on: ${{ matrix.os }}
@@ -15,7 +14,7 @@ jobs:
       matrix:
         # This should work with only the `include`s but it currently doesn't because of this bug:
         # https://github.community/t5/How-to-use-Git-and-GitHub/GitHub-Actions-Matrix-options-dont-work-as-documented/td-p/29558
-        target: 
+        target:
           - x86_64-apple-darwin
           - x86_64-unknown-linux-musl
           - x86_64-pc-windows-gnu
@@ -42,20 +41,20 @@ jobs:
           - os: macos-latest
             target: aarch64-apple-ios
     steps:
-    - uses: hecrj/setup-rust-action@v1.3.4
-      with:
-        rust-version: stable
-    - uses: actions/checkout@v1
-    - name: Build
-      id: build
-      run: scripts/dot rust release ${{ matrix.target }}
-    - name: Get the version
-      id: get_version
-      run: echo ::set-output name=VERSION::${GITHUB_REF/refs\/tags\//}
-    - name: Upload binaries to release
-      uses: svenstaro/upload-release-action@v1-release
-      with:
-        repo_token: ${{ secrets.GITHUB_TOKEN }}
-        file: target/tar/navi.${{ steps.build.outputs.EXTENSION }}
-        tag: ${{ github.ref }}
-        asset_name: navi-${{ steps.get_version.outputs.VERSION }}-${{ matrix.target }}.${{ steps.build.outputs.EXTENSION }}
+      - uses: hecrj/setup-rust-action@v1.3.4
+        with:
+          rust-version: stable
+      - uses: actions/checkout@v1
+      - name: Build
+        id: build
+        run: scripts/dot rust release ${{ matrix.target }}
+      - name: Get the version
+        id: get_version
+        run: echo ::set-output name=VERSION::${GITHUB_REF/refs\/tags\//}
+      - name: Upload binaries to release
+        uses: svenstaro/upload-release-action@v1-release
+        with:
+          repo_token: ${{ secrets.GITHUB_TOKEN }}
+          file: target/tar/navi.${{ steps.build.outputs.EXTENSION }}
+          tag: ${{ github.ref }}
+          asset_name: navi-${{ steps.get_version.outputs.VERSION }}-${{ matrix.target }}.${{ steps.build.outputs.EXTENSION }}
diff --git a/README.md b/README.md
@@ -1,75 +1,73 @@
 # navi <img src="https://raw.githubusercontent.com/denisidoro/navi/master/assets/icon.png" alt="icon" height="28px"/> [![Actions Status](https://github.com/denisidoro/navi/workflows/Tests/badge.svg)](https://github.com/denisidoro/navi/actions) ![GitHub release](https://img.shields.io/github/v/release/denisidoro/navi?include_prereleases)
-  
+
 An interactive cheatsheet tool for the command-line.
 
 [![Demo](https://asciinema.org/a/406461.svg)](https://asciinema.org/a/406461)
 
 **navi** allows you to browse through cheatsheets (that you may write yourself or download from maintainers) and execute commands. Suggested values for arguments are dynamically displayed in a list.
 
-#### Pros
+## Pros
+
 - it will spare you from knowing CLIs by heart
 - it will spare you from copy-pasting output from intermediate commands
 - it will make you type less
 - it will teach you new one-liners
 
-It uses [fzf](https://github.com/junegunn/fzf), [skim](https://github.com/lotabout/skim), or [Alfred](https://www.alfredapp.com/) under the hood and it can be either used as a command or as a shell widget (*à la* Ctrl-R).
+It uses [fzf](https://github.com/junegunn/fzf), [skim](https://github.com/lotabout/skim), or [Alfred](https://www.alfredapp.com/) under the hood and it can be either used as a command or as a shell widget (_à la_ Ctrl-R).
 
-Table of contents
------------------
+## Table of contents
 
-   * [Installation](#installation)
-   * [Usage](#usage)
-   * [Cheatsheet repositories](#cheatsheet-repositories)
-   * [Cheatsheet syntax](#cheatsheet-syntax)
-   * [Customization](#customization)
-   * [More info](#more-info)
-   * [Trying out online](#trying-out-online)
-   * [Similar tools](#similar-tools)
-   * [Etymology](#etymology)
+- [Installation](#installation)
+- [Usage](#usage)
+- [Cheatsheet repositories](#cheatsheet-repositories)
+- [Cheatsheet syntax](#cheatsheet-syntax)
+- [Customization](#customization)
+- [More info](#more-info)
+- [Trying out online](#trying-out-online)
+- [Similar tools](#similar-tools)
+- [Etymology](#etymology)
 
-Installation
-------------
+## Installation
 
 **navi** can be installed with the following package managers:
 
 [![Packaging status](https://repology.org/badge/vertical-allrepos/navi.svg)](https://repology.org/project/navi/versions)
 
-The recommended way to install **navi** is by running: 
+The recommended way to install **navi** is by running:
+
 ```sh
 brew install navi
 ```
 
 If `brew` isn't available, you can check [alternative install instructions](docs/installation.md).
 
-Usage
------
+## Usage
 
 There are multiple ways to use **navi**:
 
 - by typing `navi` in the terminal
-   - pros: you have access to all possible subcommands and flags
+  - pros: you have access to all possible subcommands and flags
 - as a [shell widget](docs/installation.md#installing-the-shell-widget) for the terminal
-   - pros: the shell history is correctly populated (i.e. with the actual command you ran instead of `navi`) and you can edit the command as you wish before executing it
+  - pros: the shell history is correctly populated (i.e. with the actual command you ran instead of `navi`) and you can edit the command as you wish before executing it
 - as [aliases](docs/aliases.md)
 - as a [shell scripting tool](docs/shell_scripting.md)
 - as an [Alfred workflow](docs/alfred.md)
 
 In particular, check [these instructions](https://github.com/denisidoro/navi/issues/491) if you want to replicate what's shown in the demo above.
 
-Cheatsheet repositories
------------------------
+## Cheatsheet repositories
 
 Running **navi** for the first time will help you download and manage cheatsheets.
 
 You can also:
+
 - [browse through featured cheatsheets](docs/cheatsheet_repositories.md#browsing-through-cheatsheet-repositories)
 - [import cheatsheets from git repositories](docs/cheatsheet_repositories.md#importing-cheatsheets)
 - [write your own cheatsheets](#cheatsheet-syntax) (and [share them](docs/cheatsheet_repositories.md#submitting-cheatsheets), if you want)
 - [use cheatsheets from other tools](docs/cheatsheet_repositories.md#using-cheatsheets-from-other-tools), such as [tldr](https://github.com/tldr-pages/tldr) and [cheat.sh](https://github.com/chubin/cheat.sh)
 - [auto-update repositories](docs/cheatsheet_repositories.md#auto-updating-repositories)
 
-Cheatsheet syntax
------------------
+## Cheatsheet syntax
 
 Cheatsheets are described in `.cheat` files that look like this:
 
@@ -84,40 +82,38 @@ $ branch: git branch | awk '{print $NF}'
 
 The full syntax and examples can be found [here](docs/cheatsheet_syntax.md).
 
-Customization
--------------
+## Customization
 
 You can:
+
 - [setup your own config file](docs/config_file.md)
 - [change colors](docs/customization.md#changing-colors)
 - [resize columns](docs/customization.md#resizing-columns)
 - [change how search is performed](docs/customization.md#overriding-fzf-options)
 
-More info
----------
+## More info
 
 Please run the following command to read more about all possible options:
+
 ```sh
 navi --help
 ```
 
 In addition, please check the [/docs](docs) folder.
 
-Trying out online
------------------
+## Trying out online
 
 If you don't have access to a Unix shell at the moment and you want to live preview **navi**, head to [this playground](https://www.katacoda.com/denisidoro/scenarios/navi). It'll start a docker container with instructions for you to install and use the tool. Note: login required.
 
-Similar tools
--------------
+## Similar tools
 
 There are many similar projects out there ([beavr](https://github.com/denisidoro/beavr), [bro](https://github.com/hubsmoke/bro), [cheat](https://github.com/cheat/cheat), [cheat.sh](https://github.com/chubin/cheat.sh), [cmdmenu](https://github.com/amacfie/cmdmenu), [eg](https://github.com/srsudar/eg), [how2](https://github.com/santinic/how2), [howdoi](https://github.com/gleitz/howdoi) and [tldr](https://github.com/tldr-pages/tldr), to name a few).
 
 They are excellent projects, but **navi** remains unique in the following ways:
+
 - it's natural to write cheatsheets tailored to your needs
 - arguments are neither hardcoded nor a simple template
 
-Etymology
----------
+## Etymology
 
 [Navi](https://zelda.gamepedia.com/Navi) is a character from [The Legend of Zelda Ocarina of Time](https://zelda.gamepedia.com/Ocarina_of_Time) that provides [Link](https://zelda.gamepedia.com/Link) with a variety of clues to help him solve puzzles and make progress in his quest.
diff --git a/docs/alfred.md b/docs/alfred.md
@@ -1,17 +1,15 @@
-Alfred
-------
+## Alfred
 
-This is *experimental*. If you face any issues, please report [here](https://github.com/denisidoro/navi/issues/348).
+This is _experimental_. If you face any issues, please report [here](https://github.com/denisidoro/navi/issues/348).
 
 ![Alfred demo](https://user-images.githubusercontent.com/3226564/80294838-582b1b00-8743-11ea-9eb5-a335d8eed833.gif)
 
 ### Note
 
-Support for alfred has been removed. 
+Support for alfred has been removed.
 
 The latest version which has some support for it is [2.15.1](https://github.com/denisidoro/navi/releases/tag/v2.15.1).
 
-
 ### Instructions
 
 - make sure you have [Alfred Powerpack](https://www.alfredapp.com/powerpack/)

diff --git a/docs/aliases.md b/docs/aliases.md
@@ -1,5 +1,4 @@
-Aliases
-----------------------------
+## Aliases
 
 **navi** doesn't have support for aliases as first-class citizens at the moment.
 

diff --git a/docs/cheatsheet_repositories.md b/docs/cheatsheet_repositories.md
@@ -1,23 +1,24 @@
-Cheatsheet repositories
------------------------
+## Cheatsheet repositories
 
-* [Browsing through cheatsheet repositories](#browsing-through-cheatsheet-repositories)
-* [Importing cheatsheets](#importing-cheatsheets)
-* [Adding your own cheatsheets](#adding-your-own-cheatsheets)
-* [Submitting cheatsheets](#submitting-cheatsheets)
-* [Using cheatsheets from other tools](#using-cheatsheets-from-other-tools)
-* [Auto-updating repositories](#auto-updating-repositories)
+- [Browsing through cheatsheet repositories](#browsing-through-cheatsheet-repositories)
+- [Importing cheatsheets](#importing-cheatsheets)
+- [Adding your own cheatsheets](#adding-your-own-cheatsheets)
+- [Submitting cheatsheets](#submitting-cheatsheets)
+- [Using cheatsheets from other tools](#using-cheatsheets-from-other-tools)
+- [Auto-updating repositories](#auto-updating-repositories)
 
 ### Browsing through cheatsheet repositories
 
 You can find cheatsheet repositories with:
+
 ```sh
 navi repo browse
 ```
 
 ### Importing cheatsheets
 
 You can import cheatsheets from any git repository that includes `.cheat` files:
+
 ```sh
 navi repo add https://github.com/denisidoro/cheats
 ```
@@ -37,11 +38,13 @@ In order to add your own repository as a featured cheatsheet repo, please [edit
 ![Demo](https://user-images.githubusercontent.com/3226564/91878474-bae27500-ec55-11ea-8b19-17876178e887.gif)
 
 You can use cheatsheets from [tldr](https://github.com/tldr-pages/tldr) by running:
+
 ```sh
 navi --tldr <query>
 ```
 
 You can use cheatsheets from [cheat.sh](https://github.com/chubin/cheat.sh) by running:
+
 ```sh
 navi --cheatsh <query>
 ```
@@ -51,19 +54,22 @@ navi --cheatsh <query>
 Right now, **navi** doesn't have support for auto-updating out of the box. However, you can achieve this by using `git` and `crontab`.
 
 First make sure you cloned your repo using `git` to the correct folder:
+
 ```sh
 user="<user>"
 repo="<repo>"
 git clone "https://github.com/${user}/${repo}" "$(navi info cheats-path)/${user}__${repo}"
 ```
 
 Then, add a cron job:
+
 ```sh
 crontab -e
 */0 11 * * * bash -c 'cd "$(/usr/local/bin/navi info cheats-path)/<user>__<repo>" && /usr/local/bin/git pull -q origin master'
 ```
 
 Please note the cron job above is just an example and you should edit it accordingly:
+
 - In this example, the cron job is triggered every day at 11am. [crontab guru](https://crontab.guru/) may come in handy if you want to change this value
 - The full paths to `navi` and `git` may differ in your setup. Check their actual values using `which navi` and `which git`
-- Don't forget to replace `<user>__<repo>` with the actual folder name
+- Don't forget to replace `<user>__<repo>` with the actual folder name