From 977d411a3b51e4799c5cbcbef9fc3dab060557e7 Mon Sep 17 00:00:00 2001 From: Wassim Metallaoui Date: Wed, 5 Jun 2024 11:57:54 -0500 Subject: [PATCH] build(docs): correct copy/paste issue of vim doc name --- .github/workflows/build.yml | 2 +- doc/scalpel.nvim.txt | 95 ------------------------------------- 2 files changed, 1 insertion(+), 96 deletions(-) delete mode 100644 doc/scalpel.nvim.txt diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 3112c6f..865962c 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -20,7 +20,7 @@ jobs: - uses: actions/checkout@v4 - uses: kdheepak/panvimdoc@main with: - vimdoc: scalpel.nvim + vimdoc: gh-navigator.nvim version: "NVIM v0.1.0" toc: true treesitter: true diff --git a/doc/scalpel.nvim.txt b/doc/scalpel.nvim.txt deleted file mode 100644 index da64f70..0000000 --- a/doc/scalpel.nvim.txt +++ /dev/null @@ -1,95 +0,0 @@ -*scalpel.nvim.txt* For NVIM v0.1.0 Last change: 2024 June 05 - -============================================================================== -Table of Contents *scalpel.nvim-table-of-contents* - -1. gh-navigator.nvim |scalpel.nvim-gh-navigator.nvim| - - Setup |scalpel.nvim-gh-navigator.nvim-setup| -2. Links |scalpel.nvim-links| - -============================================================================== -1. gh-navigator.nvim *scalpel.nvim-gh-navigator.nvim* - -This Neovim plugin makes jumping from coding to GitHub as painless as possible. - - - - -SETUP *scalpel.nvim-gh-navigator.nvim-setup* - - -PREREQUISITES ~ - -The plugin is mostly a wrapper around the GitHub CLI , -`gh`, with a few direct calls to `git`. So ensure the `gh` tool is installed -and can connect to your GitHub account. - -An example of how to setup `gh` for a macOS user is: - ->shell - brew install gh - gh auth login -< - -If you already have the `gh` tool installed, ensure it’s working: - ->shell - gh auth status -< - - -INSTALLATION ~ - -Install **gh-navigator** using your plugin manager of choice. For example, here -it is using lazy.nvim . - ->lua - { - 'wassimk/gh-navigator.nvim', - version = "*", - config = true - } -< - -I’ll also be actively developing this plugin using the `main` branch, so use -versioned releases with the `version` key to avoid unexpected breaking changes. - - -COMMANDS ~ - - ----------------------------------------------------------------------- - Command Description - ----------------------------- ----------------------------------------- - GH Heuristically open commit sha or PR using - number or search term(s) - - GHBlame Open the current file in blame view - - GHBrowse Open the current file in blob view - - GHPR Open PR by commit SHA, PR number, or - search term(s) - - GHRepo Open the current repo - ----------------------------------------------------------------------- - -USAGE ~ - -Move the cursor over a sha, PR number, or word and execute the commands. The -word under the cursor will be the argument. - -You can also call them with an argument. `:GHPR 1234` or `:GHPR c2d25b3` or -`:GH refactor the actor class` - -Most commands accept a range. For example, highlight the lines you want to -blame and execute `:GHBlame`. - -============================================================================== -2. Links *scalpel.nvim-links* - -1. *build*: https://github.com/wassimk/gh-navigator.nvim/actions/workflows/build.yml/badge.svg -2. *release*: https://img.shields.io/github/v/release/wassimk/gh-navigator.nvim?logo=github - -Generated by panvimdoc - -vim:tw=78:ts=8:noet:ft=help:norl: