nixos-config/modules/home/yazi/plugins/yatline-symlink.yazi/README.md

40 lines
783 B
Markdown
Raw Normal View History

2025-02-06 18:58:39 -05:00
# yatline-symlink.yazi
An addon to show symlink target in your [yatline.yazi](https://github.com/imsi32/yatline.yazi)'s status or header line.
![yatline-symlink example screenshot](2024-10-06-@13-18-32-scrot.png)
## Requirements
- yazi version >= 0.3.0
- [yatline.yazi](https://github.com/imsi32/yatline.yazi)
## Installation
```sh
ya pack -a lpanebr/yazi-plugins:yatline-symlink
```
## Usage
> [!IMPORTANT]
> Add this to your `~/.config/yazi/init.lua` after yatline.yazi's initialization.
```lua
require("yatline-symlink"):setup()
```
Then, add it in one of your sections in the yatline configuration using:
```lua
{ type = "coloreds", custom = false, name = "symlink" }
```
**Optional configuration:**
```lua
require("githead"):setup({
symlink_color = "white"
}
```