https://github.com/nstefan002/donutlify.nvim
Format your text in the shape of a donut! 🍩 (Inside your favorite editor)
https://github.com/nstefan002/donutlify.nvim
donut fun lua neovim neovim-plugin
Last synced: 5 months ago
JSON representation
Format your text in the shape of a donut! 🍩 (Inside your favorite editor)
- Host: GitHub
- URL: https://github.com/nstefan002/donutlify.nvim
- Owner: NStefan002
- License: gpl-3.0
- Created: 2025-01-08T12:21:17.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-01-15T15:15:27.000Z (9 months ago)
- Last Synced: 2025-03-31T22:41:31.593Z (6 months ago)
- Topics: donut, fun, lua, neovim, neovim-plugin
- Language: Lua
- Homepage:
- Size: 39.1 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🍩 Donutlify.nvim
**Donutlify** is a fun Neovim plugin that transforms your buffer text into the
shape of a donut! The usage is the same as `center` command (see `:h
:center`).
The plugin creates as many donuts as possible with the given diameter and
crafts a smaller donut from any remaining text. Bring some sweetness to your
coding with Donutlify! 🍩
## ❓How to use
`:[range]Donutlify [diameter]`
Combine lines in `[range]` in the shape of the donut with `[diameter]`
characters in diameter (by default `'textwidth'` or 80 when `'textwidth'` is 0).
If there aren't enough characters to create a donut of the preferred diameter,
create the donut with the largest possible diameter.
If `[range]` is not specified, format the entire buffer.
## 📺 Showcase
## 📋 Installation
[lazy](https://github.com/folke/lazy.nvim):
```lua
{
"NStefan002/donutlify.nvim",
lazy = false,
version = "*",
}
```
[packer](https://github.com/wbthomason/packer.nvim):
```lua
use({ "NStefan002/donutlify.nvim", tag = "*" })
```
[rocks.nvim](https://github.com/nvim-neorocks/rocks.nvim)
`:Rocks install donutlify.nvim`
> [!NOTE]
>
> - There is no need to call the `setup` function, only call it if you
> need to change some options
> - There is no need to lazy load `donutlify`, it lazy loads by default.
## 👀 See also
- [web version of this plugin](https://nstefan002.github.io/donutlify/)
- [spinning donut screensaver](https://github.com/NStefan002/donut.nvim)