https://github.com/atlj/pixie.nvim
This NeoVim plugin generates ✨fancy✨ images from your code
https://github.com/atlj/pixie.nvim
lua neovim neovim-lua-plugin neovim-plugin nvim nvim-lua nvim-plugin vim vim-plugin
Last synced: 9 months ago
JSON representation
This NeoVim plugin generates ✨fancy✨ images from your code
- Host: GitHub
- URL: https://github.com/atlj/pixie.nvim
- Owner: atlj
- Created: 2023-01-31T20:34:32.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-03-07T19:51:51.000Z (almost 3 years ago)
- Last Synced: 2025-04-06T04:59:45.597Z (9 months ago)
- Topics: lua, neovim, neovim-lua-plugin, neovim-plugin, nvim, nvim-lua, nvim-plugin, vim, vim-plugin
- Language: Lua
- Homepage:
- Size: 338 KB
- Stars: 30
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Pixie.nvim
This NeoVim plugin generates ✨fancy✨ images from your code
## Installation
> This package requires `NodeJS` to be installed.
> See [How to install NodeJS](https://gist.github.com/MichaelCurrin/aa1fc56419a355972b96bce23f3bccba)
> If you are on Linux, please make sure to take a look at [this page](https://github.com/kufii/img-clipboard#linux-use).
### Using [packer.nvim](https://github.com/wbthomason/packer.nvim)
```lua
use({
"atlj/Pixie.nvim",
run = function() vim.cmd.PixieInstall() end
})
```
## Usage
1. Highlight the text you wish to create a Screenshot from
2. Use `:PixieCopy` command to copy the generated image to your clipboard
3. You can now paste the generated image
## How does this work
This plugin uses [puppeteer](https://github.com/puppeteer/puppeteer) to headlessly render and take a screenshot of an auto-generated HTML file.
## Similar plugins
1. [vim-silicon](https://github.com/segeljakt/vim-silicon) uses [silicon](https://github.com/Aloxaf/silicon) to create images using GPU.
## Roadmap
### G: Issues to fix
1. If a line is too wide, it crashes
3. Quality multiplier cannot take a float value, and it is NaN on javascript when not defined
### H: Quality of Life
2. Add `PixieSave` command
3. Add theming support and new themes
4. Make the generated screenshots bordered
5. Get the quality etc. from a config
### Next steps:
1. Create a simple logo using Midjourney
2. Share on Twitter