README.md

down.lua

the familiar, organized future for neovim and beyond!

---

Caution

down.lua is currently in early ongoing development.

• down - the familiar, organized future for neovim
  • Introduction
  • Requirements
  • Quickstart
  • Config
  • Usage
  • Todo
  • Support
  • Credits

Introduction

• down.lua is a neovim plugin intended to bring the extensibility of org-mode or neorg with the comfort of markdown.

• In its current state, down.lua is in the beginning stages of development, currently functionining as a markdown-based version of neorg, with many planned features to come

• we want to be able to take notes like developers, without leaving behind all the ecosystem benefits of markdown.

• it's a work in progress and will be updated regularly

Requirements

Note

down.lua must have at least neovim 0.10+

Quickstart

lazy.nvim

-- Place in lazy.nvim spec
{
    "clpi/down.lua",
    version      = "*",
    lazy         = false,
    branch       = "master",
    config       = function()
      require "down".setup {
        mod = {
          workspace = {
            config = {
              default = "notes",
              workspaces = {
                default = "~/down",
                notes = "~/notes",
                personal = "~/home"
              }
            }
          }
        }
      }
    end,
    dependencies = {
      "nvim-treesitter/nvim-treesitter",
      "nvim-lua/plenary.nvim",
      "MunifTanjim/nui.nvim",
      "pysan3/pathlib.nvim",
      "nvim-telescope/telescope.nvim", -- optional
    },
}

---

plug.vim

[!Caution]

Not yet tested

Plug "nvim-telescope/telescope.nvim"
Plug "nvim-treesitter/treesitter.nvim"
Plug "nvim-lua/plenary.nvim",
Plug "MunifTanjim/nui.nvim",
Plug "pysan3/pathlib.nvim"
Plug "clpi/down.lua", {
    \ "branch" : "master",
    \ "do"     : ':lua require([[down]]).setup({
    \   mod = {
    \     workspace = {
    \       config = {
    \         workspaces = {
    \           wiki = [[~/wiki]],
    \           default = [[~/down]],
    \           notes = [[~/notes]]
    \         }
    \       }
    \     }
    \   }
    \ })'
    \ }

---

Vundle

[!Caution]

Not yet tested

Plugin "pysan3/pathlib.nvim"
Plugin 'nvim-telescope/telescope.nvim'
Plugin "nvim-lua/plenary.nvim",
Plugin "MunifTanjim/nui.nvim",
Plugin 'clpi/down.lua'

---

dein.vim

[!Caution]

Not yet tested

call dein#add("nvim-lua/plenary.nvim")
call dein#add("MunifTanjim/nui.nvim")
call dein#add('pysan3/pathlib.nvim')
call dein#add('nvim-telescope/telescope.nvim')
call dein#add('clpi/down.lua')

---

packer.nvim

[!Caution]

Not yet tested

use {
  "clp/down.lua",
  requires = {
        "nvim-telescope/telescope.nvim",
        "nvim-lua/plenary.nvim",
        "MunifTanjim/nui.nvim",
        "pysan3/pathlib.nvim"
  },
  tag = "*",
  branch = 'master',
  config = function()
      require("down").setup({
        mod = {
          workspace = {
            config = {
              workspaces = {
                default = "~/down",
                home = "~/notes",
                notes = "~/notes"
              }
            }
          }
        }
      })
  end,
}

---

mini.deps

[!Caution]

Not yet tested

{
  "clp/down.lua",
}

---

rocks.nvim

[!Caution]

Not yet tested

:Rocks install mini.lua

Config

-- Setup the initial config
-- with workspace 'home' at ~/home
-- and make it default
require("down").setup({ ---@type down.mod.Config
  mod = {
    workspace = {
      config = {
        default = 'home',
        workspaces = {
          default = "~/down",
          home = "~/notes",
          notes = "~/notes"
        }
      }
    }
  }
})

Usage

Modules

• config - configuration settings

Default Modules

...

Todo

Tip

Check out TODO.md for a more detailed list of tasks

Contributing

Tip

Check out CONTRIBUTING.md for a more detailed overview of how to contribute

Credits

down.lua is a project by clpi and is licensed under the MIT license. For information about contributing, please consult the CONTRIBUTING.md file.

special thanks goes to nvim-neorg/neorg for providing the inspiration and basis of this project.

---

thank you and keep updated!

• The down.lua book
• The down.lua wiki
• down.lua on luarocks
• down.lua on dotfyle

(back to top)