https://github.com/farias-hecdin/linkref
📌 Locally shorten links in your Markdown files.
https://github.com/farias-hecdin/linkref
lua nvim-plugin
Last synced: 5 months ago
JSON representation
📌 Locally shorten links in your Markdown files.
- Host: GitHub
- URL: https://github.com/farias-hecdin/linkref
- Owner: farias-hecdin
- License: mit
- Created: 2025-01-06T01:34:38.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-09-21T12:43:37.000Z (7 months ago)
- Last Synced: 2025-09-21T14:38:37.045Z (7 months ago)
- Topics: lua, nvim-plugin
- Language: Lua
- Homepage:
- Size: 52.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
> Translate this file into your native language using `Google Translate` or a [similar service](https://immersivetranslate.com).
# LinkRef
LinkRef es una pequeña utilidad para Neovim que te permite reemplazar enlaces largos en tus archivos Markdown por ID cortos, mientras que los enlaces originales se almacenan localmente de forma organizada en archivos separados. Esto hace que tus archivos Markdown sean más fáciles de leer y editar.
## 🗒️ Requerimientos
* [`Neovim`](https://github.com/neovim/neovim): Versión 0.7 o superior.
### Instalación
Usando [`folke/lazy.nvim`](https://github.com/folke/lazy.nvim):
```lua
{
"farias-hecdin/LinkRef",
ft = "markdown",
config = true
-- If you want to configure some options, replace the previous line with:
-- config = function()
-- end
},
```
## 🗒️ Configuración
Estas son las opciones de configuración predeterminadas:
```lua
{
id_length = 3, -- Longitud del ID.
custom_alphabet = nil, -- Caracteres validos para el ID (ej: 0123abc...).
disable_keymaps = false, -- Indicates whether keymaps are disabled.
}
```
### Atajos de teclado
Estos son los atajos de teclado predeterminados:
```lua
local opts = {buffer = 0, silent = true}
vim.keymap.set('n', 'xi', ":lua require('LinkRef').initial_config()", opts)
vim.keymap.set('n', 'xa', ":lua require('LinkRef').analyze_buffer()", opts)
vim.keymap.set('n', 'xg', ":lua require('LinkRef').go_captured()", opts)
vim.keymap.set('v', 'xg', ":lua require('LinkRef').go_selected()", opts)
vim.keymap.set('v', 'xa', ":lua require('LinkRef').add_identifier()", opts)
vim.keymap.set('v', 'xs', ":lua require('LinkRef').show_content()", opts)
```
Para más información, visite [FAQ](FAQ.md)
## 🗒️ Agradecimientos a
* [`rxi/json.lua`](https://github.com/rxi/json.lua): Una biblioteca JSON para Lua.
## 🛡️ Licencia
LinkRef está bajo la licencia MIT. Consulta el archivo `LICENSE` para obtener más información.