https://github.com/madskjeldgaard/neorg-create_link-module
Interactive prompt for creating files and links in neorg
https://github.com/madskjeldgaard/neorg-create_link-module
neorg neorg-module neovim-plugin norg
Last synced: 4 months ago
JSON representation
Interactive prompt for creating files and links in neorg
- Host: GitHub
- URL: https://github.com/madskjeldgaard/neorg-create_link-module
- Owner: madskjeldgaard
- Created: 2024-01-27T10:50:16.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-04T13:20:29.000Z (over 2 years ago)
- Last Synced: 2025-12-25T21:00:00.096Z (7 months ago)
- Topics: neorg, neorg-module, neovim-plugin, norg
- Homepage:
- Size: 3.91 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# A module for Neorg
This is a module for Neorg that allows you to easily create folders, .norg files, and insert links to these files directly in your Neorg documents using a prompt or based on visual selection.
## Installation
Install using packer:
```lua
use "madskjeldgaard/neorg-create_link-module"
```
## Configuration
In the `load` section of your neorg module, as a minimum add `["external.integrations.create_link"] = {}`, and fill out the config options:
```lua
require('neorg').setup({
load = {
["external.integrations.create_link"] = {
config = {
}
},
["core.defaults"] = {}, -- Loads default behaviour
...
})
```
This will expose a keymap to the `keymap` part of your neorg setup. Use it like this:
```lua
-- When in normal mode and using this keymapping: Prompt for path and create link
-- When in visual mode and using this keymapping: Create a link from the selected text
keybinds.map("norg", {"n", "v"}, "cl",
"Neorg keybind norg external.integrations.create_link.create_and_link")
```