Skip to content

Latest commit

 

History

History
231 lines (172 loc) · 7.53 KB

README.md

File metadata and controls

231 lines (172 loc) · 7.53 KB
Raw

Noteflow

scrnshot

Noteflow is a Neovim plugin written in Lua that aims to minimize amount of work needed to take notes and maintain a personal knowledge base of markdown notes. It provides multiple commands to ease repetitive and arduous tasks. By mapping those commands, you should be able to seamlessly manage your Vault (a folder with notes) using only a few keystrokes. Additionally, Noteflow exposes hooks to easily customize it programmatically.

Noteflow is, however, fairly opinionated when it comes to the structure of a note. It makes the following assumptions:

  • metadata is kept in a frontmatter. Frontmatter is a section of a note that is separated by a triple-dash line "---". Its content is in yaml format. For example:
---
title: Foobar
created: 2021-12-12T12:12:12
tags: [programming]
---
  • title of a note is either in the frontmatter or the first H1 header
  • tags are preferably stored in the frontmatter, but they can also be read from the body of a note in the following format: #<tag>
  • notes reference each other via [[wikilinks]]. A wikilink contains a note title and optional description. That means note titles must be unique

Noteflow also tries to be compatible with other plain note-taking apps like obsidian.md, GitJournal and vscode-markdown-notes.

This plugin does not provide environment to work with markdown files, like syntax, highlighting etc. You should use it alongside a Markdown plugin. I recommend vim-markdown.

Best used under source control.

Features

  • Live preview (powered by mume)

live preview

  • Powered, mainly, by the amazing Telescope
  • Fuzzy searching by title and tags
  • Searching by content (live grep)
  • Only plain text files - you own the data
  • Create note based on a title and a template
  • Create note by following a wikilink
  • Jump to the target note by following a wikilink, even if it's in another directory in a Vault
  • Rename a note and all its references in a Vault with a single command
  • Quickly add and remove tags
  • Update modified attribute in the frontmatter on save
  • Add hooks to personalize your experience
  • Make a daily note once per day
  • Quickly change a word into a reference (wikilink with a description)
  • Limited additional markdown support (wikilink highlighting etc.)
  • Autocompletion based on omnifunc

Check out a usage example in this ascii cast.

Requirements

Try it out!

Before jumping in to install and configure, you can test drive this plugin using preconfigured minimal setup. All you have to do is clone this repo and run make demo ! You need to have requirements installed, though.

git clone https://github.com/mnowotnik/noteflow.nvim.git
cd noteflow.nvim
bash build.sh
make demo

Commands start with Noteflow prefix. Mappings are as in Configuration.

Installation

By using a plugin manager:

  • packer
    use {'mnowotnik/noteflow.nvim', run = 'bash build.sh'}
    use 'nvim-lua/plenary.nvim'
    use 'nvim-telescope/telescope.nvim'
    use 'nvim-lua/popup.nvim'
    use 'kyazdani42/nvim-web-devicons' -- optional, use with nerd fonts
  • vim-plug
    Plug 'mnowotnik/noteflow.nvim', { 'do': 'bash build.sh' }
    Plug 'nvim-lua/plenary.nvim'
    Plug 'nvim-telescope/telescope.nvim'
    Plug 'nvim-lua/popup.nvim'
    Plug 'kyazdani42/nvim-web-devicons' " optional, use with nerd fonts

Configuration

In your neovim lua configuration files add:

require('noteflow'):setup({
    vault_dir = "~/Notes", -- nuff said

    -- relative to vault_dir or absolute
    -- "Templates" is default value
    templates_dir = "Templates",

    -- relative to vault_dir
    -- "Daily" is default value
    daily_dir = "Daily",

    -- optional hook to make note filename
    make_note_slug = function(title) return title end,

    -- optional hook to make daily note filename
    make_daily_slug = function(title) return title end,

    -- on buffer open hook
    on_open = function(bufnr)
        -- buffer local bindings and options
        vim.api.nvim_exec([=[
        setl omnifunc=v:lua.noteflow_omnifunc
        nn <buffer> <silent> <C-]> :NoteflowFollowWikilink<cr>

        set nonumber
        set norelativenumber
        set signcolumn=yes:1
        hi SignColumn guibg=bg
        ]=], false)
    end,

    -- will overwrite user's highlighting
    syntax = {
        todo = true,
        wikilink = true,
        fenced_block_overlay = true -- false by default
    }
})

Proposed mappings:

nn <leader>nd :NoteflowDaily<cr>
nn <leader>nf :NoteflowFind<cr>
nn <leader>ne :NoteflowEditTags<cr>
nn <leader>nt :NoteflowTags<cr>
nn <leader>ng :NoteflowGrep<cr>
nn <leader>ns :NoteflowStagedGrep<cr>
nn <leader>nl :NoteflowInsertLink<cr>

Vault structure

You can either keep every note in a single directory, in many small ones or a few big ones, depending on how many groups you want to split your notes into.

After you've configured Noteflow, you have to create your Vault. In the folder pointed to by vault_dir, you can create these example directories:

├── Daily # for daily notes
├── Bar # a user category
├── Foo # a user category
└── Templates # stores user templates

Ignoring files

You may have files in your Vault that you don't consider notes and you would like to prevent Noteflow from indexing them. Special file .noteflowignore exists for this purpose. Create it in the root of your Vault and define there ignore rules, one per line, like you would in .gitignore. With the compliments of ripgrep.

Highlighting

Noteflow adds a few simple tweaks to Markdown highlighting that are controlled by flags in the configuration syntax group.

syntax.todo

Completed todo items (- [x] foo bar) are rendered as strikethrough text.

syntax.wikilink

Adds Underlined hl group to wikilinks.

syntax.fenced_block_overlay

Draws straight lines over code block fences. The first fence starts with the programming language of a code block. The language is rendered an icon from a patched Nerd Font if nvim-web-devicons is available. This option can potentially affect performance since it tracks cursor moved events. It is set to false by default.

Development

Download dependencies and run the full test suite.

make test

Run a single plenary specification:

make testfile=tests/plenary/follow_link_spec.lua testfile

Notice

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.