https://github.com/cljoly/bepo.nvim

⌨️ Mappings for the bepo keyboard layout in Lua, inspired by https://github.com/michamos/vim-bepo
https://github.com/cljoly/bepo.nvim

bepo fennel hacktoberfest keyboard-layout lua mappings neovim neovim-plugin nvim

Last synced: 9 days ago
JSON representation

⌨️ Mappings for the bepo keyboard layout in Lua, inspired by https://github.com/michamos/vim-bepo

• Host: GitHub
• URL: https://github.com/cljoly/bepo.nvim
• Owner: cljoly
• License: apache-2.0
• Created: 2022-05-07T16:44:20.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-04-16T11:57:39.000Z (7 months ago)
• Last Synced: 2024-11-02T07:42:02.994Z (16 days ago)
• Topics: bepo, fennel, hacktoberfest, keyboard-layout, lua, mappings, neovim, neovim-plugin, nvim
• Language: Fennel
• Homepage: https://cj.rs/bepo-nvim/
• Size: 31.3 KB
• Stars: 16
• Watchers: 1
• Forks: 6
• Open Issues: 1
• Metadata Files:
  • Readme: Readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        


# ⌨️ bepo.nvim

![Neovim version](https://img.shields.io/badge/Neovim-0.5-57A143?style=flat&logo=neovim) [![](https://img.shields.io/badge/powered%20by-riss-lightgrey)](https://cj.rs/riss) ![GitHub tag (latest SemVer)](https://img.shields.io/github/v/tag/cljoly/bepo.nvim?color=darkgreen&sort=semver) ![Endpoint Badge](https://img.shields.io/endpoint?url=https%3A%2F%2Fd.cj.rs%2Fnvim%2Fbepo.json&cacheSeconds=90000)

Mappings for the [bepo][] layout in Lua, inspired by [vim-bepo][vb]

It aims to be faster (takes only 0.4ms at startup on my machine, while [vim-bepo][vb] requires 1.6ms) and more customizable (see `:help bepo.nvim-cherry-pick`)

## Installation

Add the plugin `cljoly/bepo.nvim` to your package manager.

If you don’t have a package manager yet, I use [paq.nvim][paq].

You can give it a try :).   

Look at the [installation instructions][paq_install] and then add the following to your config:

```lua

require "paq" {

  "cljoly/bepo.nvim",

  -- ... other packages

}

```

Then restart neovim and run `PaqInstall`. That will install the bepo.nvim plugin.

## Usage

Once the plugin is installed, you can add a call to set up the bepo mappings to your config:

``` lua

require("bepo").setup()

```

You should call the extension early in your `init.lua`, so that you can erase mappings later (or with other extensions) more easily.

## Advanced Usage

You can also apply only some mapping groups:

``` lua

require("bepo").movement()

require("bepo").tabs()

require("bepo").easy_access()

require("bepo").window()

```

See [the help file][help] for more details and the mappings installed.

## Reporting bugs

Thanks for considering reporting a bug!

We want to know if the issue is caused by:

1. the plugin itself

2. your user configuration

3. the system configuration

Please try to reproduce the bug in nvim stripped of your user configuration by running:

```

nvim --clean -u test/mock_setup.lua

```

If you can’t reproduce the bug in that “clean” nvim instance, it suggests that the bug comes from an interaction of the plugin with your user configuration. Please feel free to open an issue, mentioning that.

[bepo]: https://bepo.fr/

[help]: https://github.com/cljoly/bepo.nvim/blob/main/doc/bepo-nvim.txt

[paq]: https://github.com/savq/paq-nvim

[paq_install]: https://github.com/savq/paq-nvim?tab=readme-ov-file#installation

[vb]: https://github.com/michamos/vim-bepo