https://github.com/dhananjaylatkar/notes.nvim

Simple Note Taking Plugin
https://github.com/dhananjaylatkar/notes.nvim

neovim neovim-plugin note-taking notes nvim nvim-plugin

Last synced: about 1 month ago
JSON representation

Simple Note Taking Plugin

• Host: GitHub
• URL: https://github.com/dhananjaylatkar/notes.nvim
• Owner: dhananjaylatkar
• License: mit
• Created: 2024-02-06T12:55:42.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-02-06T15:07:38.000Z (9 months ago)
• Last Synced: 2024-08-02T13:32:22.173Z (4 months ago)
• Topics: neovim, neovim-plugin, note-taking, notes, nvim, nvim-plugin
• Language: Lua
• Homepage:
• Size: 2.93 KB
• Stars: 9
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# notes.nvim

Simple Note Taking Plugin

- No overwhelmingly extra features.

- Uses Markdown because that's more than enough. (And why would you want to learn something just to take notes)

- Configure root directory and start being productive.

## Installation

Using [lazy.nvim](https://github.com/folke/lazy.nvim)

```lua

{

  "dhananjaylatkar/notes.nvim",

  dependencies = {

    "nvim-telescope/telescope.nvim", -- for picker="telescope"

    "echasnovski/mini.pick", -- for picker="mini-pick"

  },

  opts = {

    -- USE EMPTY FOR DEFAULT OPTIONS

    -- DEFAULTS ARE LISTED BELOW

  },

}

```

## Configuration

_**You must run `require("notes").setup()` to initialize the plugin.**_

_notes.nvim_ comes with following defaults:

```lua

{

  -- notes root dir

  root = os.getenv("HOME") .. "/code/notes/",

  -- picker

  picker = "telescope", -- "telescope" or "mini-pick"

}

```

## Commands

| Command      | Action                      |

| ------------ | --------------------------- |

| `:NotesFind` | Find notes in root dir      |

| `:NotesGrep` | Grep notes in root dir      |

| `:NotesNew`  | Create new note in root dir |