frandsoh / simple-wiki.nvim

Simple note system via linking markdown files in wiki style

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

simple wiki example

Requirements

Instalation

With vim-plug:

Plug "nvim-lua/plenary.nvim"
Plug "rafcamlet/simple-wiki.nvim"

Configuration

require 'simple-wiki'.setup {
  path = '~/my_wiki', -- your wiki directory - must be set
  link_key_mapping = '<cr>' -- open or create note form link - default: <cr>
}

Usage

require "simple-wiki".index() -- open wiki index file
require "simple-wiki".search() -- open Telescope in wiki directory - requires telescope.nvim
require "simple-wiki".open_or_create() -- Open or create link from current word
require "simple-wiki".create_link() -- create link from current word
require "simple-wiki".create_link(true) -- create link from visual selection

open_or_create and create_link(true) are automatically mapped to link_key_mapping for files under wiki directory.


Warning: Under development - configuration and api may change in the future

About

Simple note system via linking markdown files in wiki style

License:Apache License 2.0


Languages

Language:Lua 100.0%