no-neck-pain.nvim

<p align="center">
  <h1 align="center">☕ no-neck-pain.nvim</h1>
</p>

<p align="center">
	Dead simple plugin to center the currently focused buffer to the middle of the screen.
</p>

<div align="center">

![no-neck-pain.nvim toggling, splitting, and resizing](https://raw.githubusercontent.com/wiki/shortcuts/no-neck-pain.nvim/assets/hero.gif)

</div>

no-neck-pain.nvim opens an empty window on each side of the focused window, so your code sits in the middle of the screen at a fixed width. It does not change your splits, tabs, or keymaps, and it works with no configuration.

<!-- SECTION: FEATURES -->
## ⚡️ Features

- Works without configuration: run `:NoNeckPain`.
- Keeps the layout centered across [splits and vsplits](https://github.com/shortcuts/no-neck-pain.nvim/wiki/Showcase#splits), tabs, and terminal resizes.
- Side buffers can be [colored](https://github.com/shortcuts/no-neck-pain.nvim/wiki/Showcase#side-buffer-colors) or used as [scratch pads](https://github.com/shortcuts/no-neck-pain.nvim/wiki/Showcase#side-buffers-as-scratch-pads) that save to a file.
- [Integrates](https://github.com/shortcuts/no-neck-pain.nvim/wiki/Integrations) with file trees (neo-tree, nvim-tree, snacks explorer), symbol panels (aerial, outline), neotest, nvim-dap-ui, and dashboards.
- Requires Neovim 0.10 or later. For Neovim 0.7 and 0.8, use the frozen [1.x branch](https://github.com/shortcuts/no-neck-pain.nvim/tree/1.x). For 0.9, use the [2.x branch](https://github.com/shortcuts/no-neck-pain.nvim/tree/2.x).

<!-- SECTION: INSTALLATION -->
## 📋 Installation

Pin a release with the snippets below. Remove the version pin to follow `main`.

[folke/lazy.nvim](https://github.com/folke/lazy.nvim)

```lua
{ "shortcuts/no-neck-pain.nvim", version = "*" }
```

[wbthomason/packer.nvim](https://github.com/wbthomason/packer.nvim)

```lua
use({ "shortcuts/no-neck-pain.nvim", tag = "*" })
```

[junegunn/vim-plug](https://github.com/junegunn/vim-plug)

```vim
Plug 'shortcuts/no-neck-pain.nvim', { 'tag': '*' }
```

[nix-community/nixvim](https://github.com/nix-community/nixvim)

```nix
plugins.no-neck-pain.enable = true;
```

<!-- SECTION: GETTING_STARTED -->
## ☄ Getting started

Run `:NoNeckPain` to center the current window. Run it again to go back to your normal layout.

To change the defaults, call `setup()` once in your config. This example sets the centered width to 120 columns, enables the default keymaps (`<Leader>np` toggles the plugin), and turns the plugin on when Neovim starts:

```lua
require("no-neck-pain").setup({
    width = 120,
    mappings = { enabled = true },
    autocmds = { enableOnVimEnter = true },
})
```

<!-- SECTION: CONFIGURATION -->
## ⚙ Configuration

Every option is optional. The [Showcase](https://github.com/shortcuts/no-neck-pain.nvim/wiki/Showcase) has a screenshot for the common ones. Inside Neovim, `:h NoNeckPain.options` lists the plugin options and `:h NoNeckPain.bufferOptions` lists the side buffer options.

<details>
<summary>All option