https://github.com/rguruprakash/simple-note.nvim

A simple note taking plugin for neovim
https://github.com/rguruprakash/simple-note.nvim

neovim neovim-plugin notes nvim nvim-plugin

Last synced: 3 months ago
JSON representation

A simple note taking plugin for neovim

• Host: GitHub
• URL: https://github.com/rguruprakash/simple-note.nvim
• Owner: rguruprakash
• License: mit
• Created: 2024-01-27T11:27:07.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-15T18:25:19.000Z (4 months ago)
• Last Synced: 2024-10-17T03:14:01.902Z (4 months ago)
• Topics: neovim, neovim-plugin, notes, nvim, nvim-plugin
• Language: Lua
• Homepage:
• Size: 28.3 KB
• Stars: 12
• Watchers: 1
• Forks: 7
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Neovim Simple Note Plugin

This is a very minimalist note-taking plugin for Neovim. It provides functionality to create, list, preview, rename, and delete notes.

#### Motivation

I've always desired a simple, straightforward note-taking method in vim. I'm only interested in basic functions such as creating, listing, deleting, renaming, and previewing notes. I don't need advanced features like nested notes or linking notes - just plain markdown notes will do. This plugin attempts to do the same with the help of telescope.nvim

## Features

- Create a new note file with a unique timestamp or the provided filename as argument.

- List all existing notes in a Telescope prompt.

- Preview notes in a Telescope prompt.

- Delete a selected note file.

- Rename a selected note file.

## Installation and Configuration

**Lazy**

```lua

{

    'rguruprakash/simple-note.nvim',

    dependencies = {

        'nvim-lua/plenary.nvim',

        'nvim-telescope/telescope.nvim',

    },

    config = function ()

        require('simple-note').setup({

            -- Optional Configurations

            notes_dir = '~/notes/', -- default: '~/notes/'

            notes_directories = { -- default: {}

                '~/notes/',

                '~/work/',

                '~/personal/'

            },

            telescope_new = '', -- default:  

            telescope_delete = '', -- default: 

            telescope_rename = '', -- default: 

            telescope_change_directory = ''  -- default: 

        })

    end

}

```

## Usage

### Commands

- `:SimpleNoteList`: Lists all existing notes in a Telescope prompt.

- `:SimpleNoteCreate [filename (optional)]`: Creates a new note file and opens it in Neovim.

- `:SimpleNotePickDirectory`: Pick notes directory.

### Telescope default prompt keymaps

- ``: Creates new note (using the current line in the search prompt if any)

- ``: Delete note

- ``: Rename note

- ``: Change notes directory

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.