Fix the documentation somewhat

This commit is contained in:
Maximilian Friedersdorff 2024-10-22 10:16:45 +01:00
parent 6c05ee60b5
commit 298fa387c8

View file

@ -1,25 +1,22 @@
# openingh.nvim # openingh.nvim
Opens the current file or project page in GitHub.
Opens the current file or project page in the web interface of the remote.
![Lua](https://img.shields.io/badge/Made%20with%20Lua-blueviolet.svg?style=for-the-badge&logo=lua) ![Lua](https://img.shields.io/badge/Made%20with%20Lua-blueviolet.svg?style=for-the-badge&logo=lua)
![GitHub release (latest by date)](https://img.shields.io/github/v/release/almo7aya/openingh.nvim?style=for-the-badge)
[![lint with luacheck](https://img.shields.io/github/actions/workflow/status/almo7aya/openingh.nvim/lint.yml?style=for-the-badge)](https://github.com/Almo7aya/openingh.nvim/actions/workflows/lint.yml)
![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/almo7aya/openingh.nvim/ci.yml?label=TESTS&style=for-the-badge)
- Features
- Supports macOS, Linux, Windows and WSL
- Works with detached HEAD and supports checked out branches or forks
- Automatically selects the correct line number on the file page
- Supports GitHub, GitHub Enterprise, GitLab, and Bitbucket
- Features - Demo
- Supports macOS, Linux, Windows and WSL
- Works with detached HEAD and supports checked out branches or forks
- Automatically selects the correct line number on the file page
- Supports GitHub, GitHub Enterprise, GitLab, and Bitbucket
- Demo
![](./gifs/demo.gif) ![](./gifs/demo.gif)
## Requirements ## Requirements
- Neovim 0.7.2+ - Neovim 0.7.2+
## Installation ## Installation
@ -30,21 +27,21 @@ Opens the current file or project page in GitHub.
```lua ```lua
-- init.lua -- init.lua
require("packer").startup(function() require("packer").startup(function()
use "almo7aya/openingh.nvim" use "https://gitea.gwairfelin.com/max/openingh.nvim"
end) end)
``` ```
## Commands ## Commands
- `:OpenInGHRepo` - `:OpenInGHRepo`
- Opens the project's git repository page in GitHub. - Opens the project's git repository page in the remote.
- `:OpenInGHFile` - `:OpenInGHFile`
- Opens the current file page in GitHub. This command supports ranges. - Opens the current file page in the remote.
- `:OpenInGHFileLines` - `:OpenInGHFileLines`
- Opens the current file page in GitHub. This command supports ranges. - Opens the current file page in the remote, with the lines highlighted. This
command supports ranges.
## Registers ## Registers
@ -77,15 +74,14 @@ vim.api.nvim_set_keymap("v", "<Leader>gf", ":OpenInGHFileLines <CR>", { silent =
## TODO ## TODO
- [x] Support the current file cursor position - [x] Support the current file cursor position
- [x] Support visual mode to open a file in range selection - [x] Support visual mode to open a file in range selection
- [x] Support other version control websites - [x] Support other version control websites
## Contribution ## Contribution
Feel free to open an issue or a pull request if you have any suggestions or improvements Feel free to open an issue or a pull request if you have any suggestions or improvements
## License ## License
[MIT](./LICENSE) [MIT](./LICENSE)