Neorg requires at least Neovim 0.8+ to operate.
sample init.lua
-- adapted from https://github.com/folke/lazy.nvim#-installation
local lazypath = vim.fn.stdpath("data") .. "/lazy/lazy.nvim"
if not vim.loop.fs_stat(lazypath) then
print(vim.fn.system({
"git",
"clone",
"--filter=blob:none",
"https://github.com/folke/lazy.nvim.git",
"--branch=stable",
lazypath,
}))
end
vim.opt.rtp:prepend(lazypath)
vim.g.mapleader = " "
require("lazy").setup({
"rebelot/kanagawa.nvim", -- neorg needs a colorscheme with treesitter support
{
"nvim-treesitter/nvim-treesitter",
build = ":TSUpdate",
opts = {
highlight = { enable = true },
},
config = function(_, opts)
require("nvim-treesitter.configs").setup(opts)
end,
},
{
"nvim-neorg/neorg",
build = ":Neorg sync-parsers",
dependencies = { "nvim-lua/plenary.nvim" },
config = function()
require("neorg").setup {
load = {
["core.defaults"] = {},
["core.concealer"] = {},
["core.dirman"] = {
config = {
workspaces = {
notes = "~/notes",
},
default_workspace = "notes",
},
},
},
}
vim.wo.foldlevel = 99
vim.wo.conceallevel = 2
end,
}
})
vim.cmd.colorscheme('kanagawa')You can install it through your favorite plugin manager:
-
packer.nvim
use { "qrxnz/oldneorg", config = function() require('neorg').setup { load = { ["core.defaults"] = {}, -- Loads default behaviour ["core.concealer"] = {}, -- Adds pretty icons to your documents ["core.dirman"] = { -- Manages Neorg workspaces config = { workspaces = { notes = "~/notes", }, }, }, }, } end, run = ":Neorg sync-parsers", requires = "nvim-lua/plenary.nvim", }
Every time Neorg hits a new release, a new tag is created by us, so you don't have to worry about all the updates inbetween. That means that adding
tag = "*"in Packer will update to latest stable release.You can also pin Neorg to one specific version through e.g.
tag = "2.0.0".
Want to lazy load? You can use the
ftkey to load Neorg only upon entering a.norgfile:use { "qrxnz/oldneorg", -- tag = "*", ft = "norg", after = "nvim-treesitter", -- You may want to specify Telescope here as well config = function() require('neorg').setup { load = { ["core.defaults"] = {}, -- Loads default behaviour ["core.concealer"] = {}, -- Adds pretty icons to your documents ["core.dirman"] = { -- Manages Neorg workspaces config = { workspaces = { notes = "~/notes", }, }, }, }, } end }
Although it's proven to work for a lot of people, you might need to take some additional steps depending on how your lazyloading system and/or Neovim config is set up.
-
vim-plug
Plug 'qrxnz/oldneorg' | Plug 'nvim-lua/plenary.nvim'
You can then put this initial configuration in your
init.vimfile:lua << EOF require('neorg').setup { load = { ["core.defaults"] = {}, -- Loads default behaviour ["core.concealer"] = {}, -- Adds pretty icons to your documents ["core.dirman"] = { -- Manages Neorg workspaces config = { workspaces = { notes = "~/notes", }, }, }, }, } EOF
-
lazy.nvim
require("lazy").setup({ { "qrxnz/oldneorg", build = ":Neorg sync-parsers", dependencies = { "nvim-lua/plenary.nvim" }, config = function() require("neorg").setup { load = { ["core.defaults"] = {}, -- Loads default behaviour ["core.concealer"] = {}, -- Adds pretty icons to your documents ["core.dirman"] = { -- Manages Neorg workspaces config = { workspaces = { notes = "~/notes", }, }, }, }, } end, }, })
With the above run key set, every time you update Neorg the internal parsers
will also be updated to the correct revision.