Skip to content

rafcamlet/simple-wiki.nvim

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 

Repository files navigation

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

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages