https://github.com/rafcamlet/simple-wiki.nvim

Simple note system via linking markdown files in wiki style
https://github.com/rafcamlet/simple-wiki.nvim

Last synced: 4 months ago
JSON representation

Simple note system via linking markdown files in wiki style

• Host: GitHub
• URL: https://github.com/rafcamlet/simple-wiki.nvim
• Owner: rafcamlet
• License: apache-2.0
• Created: 2021-01-18T10:13:25.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2021-01-18T10:55:12.000Z (almost 4 years ago)
• Last Synced: 2024-02-17T14:35:13.517Z (9 months ago)
• Language: Lua
• Size: 818 KB
• Stars: 18
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![simple wiki example](/gifs/example.gif)

## Requirements

- neovim v0.5-dev - nightly build

- [plenary.nvim](https://github.com/nvim-lua/plenary.nvim)

- [telescope.nvim](https://github.com/nvim-telescope/telescope.nvim) (optional)

## Instalation

With vim-plug:

```

Plug "nvim-lua/plenary.nvim"

Plug "rafcamlet/simple-wiki.nvim"

```

## Configuration

```lua

require 'simple-wiki'.setup {

  path = '~/my_wiki', -- your wiki directory - must be set

  link_key_mapping = '' -- open or create note form link - default: 

}

```

## Usage

```lua

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