Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nvim-neorg/neorg
Modernity meets insane extensibility. The future of organizing your life in Neovim.
https://github.com/nvim-neorg/neorg
lua neorg neovim neovim-plugin nvim org-mode organization
Last synced: 3 days ago
JSON representation
Modernity meets insane extensibility. The future of organizing your life in Neovim.
- Host: GitHub
- URL: https://github.com/nvim-neorg/neorg
- Owner: nvim-neorg
- License: gpl-3.0
- Created: 2021-04-11T17:35:43.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-27T15:06:15.000Z (about 2 months ago)
- Last Synced: 2024-10-29T14:53:26.713Z (about 1 month ago)
- Topics: lua, neorg, neovim, neovim-plugin, nvim, org-mode, organization
- Language: Lua
- Homepage:
- Size: 4.76 MB
- Stars: 6,443
- Watchers: 46
- Forks: 213
- Open Issues: 184
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: docs/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Codeowners: .github/CODEOWNERS
- Roadmap: ROADMAP.md
Awesome Lists containing this project
- awesome-neovim - nvim-neorg/neorg - Modernity meets insane extensibility. The future of organizing your life. (Note Taking / Cursorline)
README
# Neorg - An Organized Future
Your New Life Organization Tool - All in Lua
[Tutorial](#-tutorial)
•
[Roadmap](/ROADMAP.md)
•
[Installation](#-installation)
•
[Further Learning](#-further-learning)
[Credits](#credits)
•
[Support](#support)
**:warning: Neorg `9.0.0` has introduced some breaking changes! Please see [this blog post](https://vhyrro.github.io/posts/neorg-9-0-0/) on what changed.**
## Summary
Neorg (_Neo_ - new, _org_ - organization) is a Neovim plugin designed to reimagine organization as you know it.
Grab some coffee, start writing some notes, let your editor handle the rest.
### What is Neorg?
Neorg is an all-encompassing tool based around structured note taking, project and task management, time
tracking, slideshows, writing typeset documents and much more. The premise is that all of these features are
built on top of a single base file format (`.norg`), which the user only has to learn once to gain access to
all of Neorg's functionality.
Not only does this yield a low barrier for entry for new users it also ensures that all features are integrated with each
other and speak the same underlying language. The file format is built to be expressive and easy to parse,
which also makes `.norg` files easily usable anywhere outside of Neorg itself.
A good way of thinking about Neorg is as a plaintext environment which can be adapted to a variety of use cases.
If a problem can be represented using raw text, it can be solved using Neorg.
###### :exclamation: **IMPORTANT**: Neorg is young software. We consider it stable however be prepared for occasional breaking workflow changes. Make sure to pin the version of Neorg you'd like to use and only update when you are ready.
## 🌟 Tutorial
A video tutorial may be found on Youtube:
## 📦 Installation
Neorg's setup process is slightly more complex than average, so we encourage you to be patient :)
**Neorg requires Neovim 0.10 or above to function. After you're done with the
installation process, run `:checkhealth neorg` to see if everything's
correct!**
### `rocks.nvim`
One way of installing Neorg is via [rocks.nvim](https://github.com/nvim-neorocks/rocks.nvim).
Installation snippet.
- Run `:Rocks install rocks-config.nvim` (if you don't have it already!).
- Run `:Rocks install neorg`.
- From the root of your configuration (`~/.config/nvim/` on unix-like systems), create a `lua/plugins/neorg.lua` file and place the following content inside:
```lua
require("neorg").setup()
```
For the time being you also need `nvim-treesitter` installed, but the plugin is not readily available on luarocks yet.
To counter this, you also need to run the following:
- `:Rocks install rocks-git.nvim`
- `:Rocks install nvim-treesitter/nvim-treesitter`
- Just like the `neorg.lua` file, create a `lua/plugins/treesitter.lua` file and place the following content inside:
```lua
require("nvim-treesitter.configs").setup({
highlight = {
enable = true,
},
})
```
The last three steps will eventually not be required to run Neorg.
### `neorg-kickstart`
Not bothered to set up Neovim on your own? Check out our [kickstart config](https://github.com/nvim-neorg/neorg/wiki/Kickstart)
which will get you up and running with Neorg without any prior Neovim configuration knowledge.
### `lazy.nvim`
To install Neorg via lazy, first ensure that you have `luarocks` installed on your system.
On Linux/Mac, this involves installing using your system's package manager. On Windows, consider
the [Lua for Windows](https://github.com/rjpcomputing/luaforwindows) all-in-one package.
Click for installation snippet.
```lua
{
"nvim-neorg/neorg",
lazy = false, -- Disable lazy loading as some `lazy.nvim` distributions set `lazy = true` by default
version = "*", -- Pin Neorg to the latest stable release
config = true,
}
```
### `packer.nvim`
Neorg can be installed purely via luarocks on packer, pulling in all required dependencies in the process.
It is not recommended to use packer as it is now unmaintained.
Click for installation snippet.
```lua
use {
"nvim-neorg/neorg",
rocks = { "lua-utils.nvim", "nvim-nio", "nui.nvim", "plenary.nvim", "pathlib.nvim" },
tag = "*", -- Pin Neorg to the latest stable release
config = function()
require("neorg").setup()
end,
}
```
### Other Plugin Managers
Because of the complexities of `luarocks`, we are choosing not to support other plugin managers for the time
being. It is actively on our TODO list, however!
## 📚 Further Learning
After you have installed Neorg, we recommend you head over to either the Youtube tutorial series or to the [wiki](https://github.com/nvim-neorg/neorg/wiki)!
## Credits
Massive shoutouts go to all the contributors actively working on the project together to form a fantastic
integrated workflow:
- [mrossinek](https://github.com/mrossinek) - for basically being my second brain when it comes to developing new features
and adding new syntax elements
- [danymat](https://github.com/danymat) - for creating the excellent foundations for the up and coming GTD system
And an extra thank you to:
- [Binx](https://github.com/dvchoudh) - for making that gorgeous logo for free!
- [bandithedoge](https://github.com/bandithedoge) - for converting the PNG version of the logo into SVG form
## Support
Love what I do? Want to see more get done faster? Want to support future projects? Any sort of support is always
heartwarming and fuels the urge to keep going :heart:. You can show support here:
- [Buy me a coffee!](https://buymeacoffee.com/vhyrro)
- [Support me via Github Sponsors](https://github.com/sponsors/vhyrro)
- [Support me on Patreon](https://patreon.com/vhyrro)
Immense thank you to all of the sponsors of my work!
