the familiar, organized future for neovim and beyond!
Caution
down.nvim is currently in early ongoing development.
-
down.nvimis a neovim plugin intended to bring the extensibility of org-mode or neorg with the comfort of markdown. -
In its current state,
down.nvimis 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
Note
down.nvim must have at least neovim 0.10+
lazy.nvim
-- Place in lazy.nvim spec
{
"clpi/down.nvim",
command = { "Down" },
keys = {
{ "<space>di", "<CMD>Down index<CR>", desc = "Down index" },
{ "<space>dny", "<CMD>Down note yesterday<CR>", desc = "Down yesterday" },
{ "<space>dnt", "<CMD>Down note today<CR>", desc = "Down today" },
{ "<space>dnT", "<CMD>Down note tomorrow<CR>", desc = "Down tomorrow" },
{ "<space>dnm", "<CMD>Down note month<CR>", desc = "Down month" },
{ "<space>dny", "<CMD>Down note year<CR>", desc = "Down year" },
{ "<space>dnw", "<CMD>Down note week<CR>", desc = "Down week" },
{ "<space>dw", "<CMD>Down workspace<CR>", desc = "Down workspace" },
{ "<space>dc", "<CMD>Down calendar<CR>", desc = "Down calendar" },
{ "<space>df", "<CMD>Down find<CR>", desc = "Down find" },
{ "<space>dn", "<CMD>Down note<CR>", desc = "Down note" },
{ "<space>dp", "<CMD>Down note template<CR>", desc = "Down note template" },
{ "<space>dd", "<CMD>Down<CR>", desc = "Down" },
}
lazy = false,
opts = {
workspace = {
default = "notes",
workspaces = {
notes = "~/notes",
wiki = "~/wiki",
}
}
},
dependencies = {
"nvim-treesitter/nvim-treesitter",
-- And an optional picker, if you want that functionality
"nvim-telescope/telescope.nvim", -- optional
-- "folke/snacks.nvim", -- optional
},
}Builtin
-- Add to your `init.lua`
vim.pack.add({
{ src = "https://github.com/clpi/down.nvim" }
})
plug.vim
[!Caution]
Not yet tested
Plug "nvim-telescope/telescope.nvim" " optional
Plug "nvim-treesitter/treesitter.nvim"
Plug "clpi/down.nvim", {
\ "branch" : "master",
\ "do" : ':lua require([[down]]).setup({
\ workspace = {
\ default = [[wiki]],
\ workspaces = {
\ wiki = [[~/wiki]],
\ notes = [[~/notes]]
\ }
\ }
\ })'
\ }dein.vim
[!Caution]
Not yet tested
call dein#add('nvim-telescope/telescope.nvim')
call dein#add('clpi/down.nvim')packer.nvim
[!Caution]
Not yet tested
use {
"clpi/down.nvim",
requires = {
"nvim-telescope/telescope.nvim",
},
tag = "*",
branch = 'master',
config = function()
require("down").setup({
workspace = {
default = "notes",
workspaces = {
home = "~/notes",
notes = "~/notes"
}
}
})
end,
}mini.deps
[!Caution]
Not yet tested
local add = require("mini.deps").add
add({
source = "clpi/down.nvim",
depends = {
"nvim-telescope/telescope.nvim",
},
})
require("down").setup({
workspace = {
default = "notes",
workspaces = {
home = "~/notes",
notes = "~/notes"
}
}
})-- Setup the initial config
-- with workspace 'home' at ~/home
-- and make it default
require("down").setup({ ---@type down.mod.Config
workspace = {
default = 'home',
workspaces = {
home = "~/notes",
notes = "~/notes"
}
}
})config- configuration settings
...
Tip
Check out TODO.md for a more detailed list of tasks
Tip
Check out CONTRIBUTING.md for a more detailed overview of how to contribute
down.nvim 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!