README.md

scribe.nvim

A convenient way to find and take notes written in Lua.

Contents

• Getting Started
• Usage
• Setup
• Contributing
• Wish List

Getting Started

Required Dependencies

• telescope.nvim is required to find notes.
• nui.vim is required for text prompt.

Installation

vim-plug

Plug 'Ostralyan/scribe.nvim'
" Telescope is a required dependency for :ScribeFind to work
Plug 'nvim-telescope/telescope.nvim', { 'tag': '0.1.0' }

packer.nvim

return require('packer').startup(function(use)
  use 'nvim-telescope/telescope.nvim', tag = '0.1.0',
  use 'Ostralyan/scribe.nvim'
end)

dein.vim

call dein#add('nvim-telescope/telescope.nvim', { 'rev': '0.1.0' })
call dein#add('Ostralyan/scribe.nvim')

Usage

" Creates a new default file (scribe.md) or opens the file up if it exists.
" The default file can be configured under setup.
nnoremap <leader>ss :ScribeOpen<cr>

" Creates a new file or opens the file up if it exists.
" Requires a filename.
nnoremap <leader>so :ScribeOpen<space>

" Opens telescope up to <directory>
" The directory can be configured in setup.
nnoremap <leader>sf :ScribeFind<cr>

Setup

Default setup

-- Default values
-- {
--   directory = '~/notes',
--   file_ext = 'md',
--   default_file = 'scribe'
-- }
require('scribe').setup{}

Custom setup with project root as default directory

require('scribe').setup{
  directory = './notes',
  file_ext = '.txt',
  default_file = 'scribe'
}

Contributing

All contributions are welcome! Just open a pull request. Feel free to take stab at wish list.

Wish List

• Support markdown preview
• Add setup configuration to allow for customizable preview.
• More Usage examples for packer, dein, and more
• Setup examples in Lua
• Add multiple search directories