silicon.lua

KO | EN

gitlite — search

#javascript #typescript #android #deep-learning #linux #docker #nodejs #java #awesome #awesome-list #pytorch #ios #mcp #openai

(★ 158)

Beautiful code snippet images right in the most epic editor :chef_kiss:

파일 탐색기

최종 버전 다운로드 (.zip)

- - build_tmTheme.lua
  - config.lua
  - init.lua
  - request.lua
  - utils.lua
.envrc
.gitignore
flake.lock
flake.nix
LICENSE
README.md

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# silicon.lua

**silicon** is a lua plugin for neovim to generate beautiful images of code snippet using [silicon](https://github.com/aloxaf/silicon)

## ✨ Features

- **beautiful** images of source code, saved to preferred place.
- **copy** to clipboard

## ⚡️ Requirements

- Neovim >= 0.6.0
- [silicon](https://github.com/aloxaf/silicon)
- [wl-clipboard](https://github.com/bugaevc/wl-clipboard) (on wayland)

## 📦 Installation

Install the plugin with your preferred package manager:

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

```lua
-- Lua
use {
  "narutoxy/silicon.lua",
  requires = { "nvim-lua/plenary.nvim" },
  config = function()
    require('silicon').setup({})
  end
}
```

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

```vim
" Vim Script
Plug 'nvim-lua/plenary.nvim'
Plug 'narutoxy/silicon.lua'

lua require('silicon').setup({})
```

## ⚙️ Configuratioon

silicon comes with the following defaults:

```lua
{
	theme = "auto",
	output = "SILICON_${year}-${month}-${date}_${time}.png", -- auto generate file name based on time (absolute or relative to cwd)
	bgColor = vim.g.terminal_color_5,
	bgImage = "", -- path to image, must be png
	roundCorner = true,
	windowControls = true,
	lineNumber = true,
	font = "monospace",
	lineOffset = 1, -- from where to start line number
	linePad = 2, -- padding between lines
	padHoriz = 80, -- Horizontal padding
	padVert = 100, -- vertical padding
	shadowBlurRadius = 10,
	shadowColor = "#555555",
	shadowOffsetX = 8,
	shadowOffsetY = 8,
	gobble = false, -- enable lsautogobble like feature
	debug = false, -- enable debug output
}
```

# 🚀 Usage

## Keymaps

```lua
-- Generate image of lines in a visual selection
vim.keymap.set('v', '<Leader>s',  function() silicon.visualise_api({}) end )
-- Generate image of a whole buffer, with lines in a visual selection highlighted
vim.keymap.set('v', '<Leader>bs', function() silicon.visualise_api({to_clip = true, show_buf = true}) end )
-- Generate visible portion of a buffer
vim.keymap.set('n', '<Leader>s',  function() silicon.visualise_api({to_clip = true, visible = true}) end )
-- Generate current buffer line in normal mode
vim.keymap.set('n', '<Leader>s',  function() silicon.visualise_api({to_clip = true}) end )
```

## Command line

Calling `silicon.visualise_api` with `lua` in command line doesn't work due to `lua` not supporting ranges.  
This means that the moment you hit enter, you leave visual mode before lua function is called. While this populates two registers, using them doesn't work with "v" mode maps.  
A workaround has been implemented, and a shorthand that forces it is available as `.visualise_cmdline`:

- Generate image of lines in a visual selection

```lua
    lua require('silicon').visualise_cmdline({})
    ```

- Generate image of a whole buffer, with lines in a visual selection highlighted

```lua
    lua require('silicon').visualise_cmdline({to_clip = true, show_buf = true})
    ```

- Generate visible portion of a buffer

```lua
    lua require('silicon').visualise_cmdline({to_clip = true, visible = true})
    ```

## Notes

- The default path of image is the current working directory of the editor, but you can change it by

```lua
    require("silicon").setup({
            output = "/home/astro/Pictures/SILICON_$year-$month-$date-$time.png"),
    })
    ```

## Colorscheme reloading

Autogenerated silicon themes are unaware of dark/light variants.
Utility functions had been exposed that allow regenerating theme on demand:

- `require("silicon.utils").build_tmTheme()` builds a new tmTheme file from current colorscheme
- `require("silicon.utils").reload_silicon_cache()` calls `silicon --build-cache`

This lets one regenerate theme when switching background setting or otherwise reloading `ColorScheme`:

```lua
vim.api.nvim_create_augroup('SiliconRefresh', { clear = true })
vim.api.nvim_create_autocmd({ 'ColorScheme' },
	{
	group = 'SiliconRefresh',
	callback = function()
		silicon_utils.build_tmTheme()
		silicon_utils.reload_silicon_cache({async = true})
	end,
	desc = 'Reload silicon themes cache on colorscheme switch',
	}
)
```

silicon.lua

파일 탐색기

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

silicon.lua

파일 탐색기

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README