{"id":13412214,"url":"https://github.com/nvim-neorg/neorg","last_synced_at":"2026-04-09T04:01:02.736Z","repository":{"id":37570651,"uuid":"356935454","full_name":"nvim-neorg/neorg","owner":"nvim-neorg","description":"Modernity meets insane extensibility. The future of organizing your life in Neovim.","archived":false,"fork":false,"pushed_at":"2025-04-30T21:16:42.000Z","size":4913,"stargazers_count":6848,"open_issues_count":200,"forks_count":228,"subscribers_count":49,"default_branch":"main","last_synced_at":"2025-04-30T22:27:37.581Z","etag":null,"topics":["lua","neorg","neovim","neovim-plugin","nvim","org-mode","organization"],"latest_commit_sha":null,"homepage":"","language":"Lua","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nvim-neorg.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"docs/CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":"ROADMAP.md","authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"open_collective":"neorg","github":["vhyrro","danymat"],"ko_fi":null,"tidelift":null,"community_bridge":null,"issuehunt":null,"otechie":null,"custom":["https://buymeacoffee.com/vhyrro"]}},"created_at":"2021-04-11T17:35:43.000Z","updated_at":"2025-04-30T21:16:18.000Z","dependencies_parsed_at":"2023-10-16T09:13:21.864Z","dependency_job_id":"aa13879b-fd38-41a9-88c1-0c37cd41f3c3","html_url":"https://github.com/nvim-neorg/neorg","commit_stats":{"total_commits":3401,"total_committers":141,"mean_commits":"24.120567375886523","dds":"0.46868568068215233","last_synced_commit":"ba35900b21921c439e676b063a79c8fad914eac9"},"previous_names":[],"tags_count":60,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nvim-neorg%2Fneorg","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nvim-neorg%2Fneorg/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nvim-neorg%2Fneorg/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nvim-neorg%2Fneorg/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nvim-neorg","download_url":"https://codeload.github.com/nvim-neorg/neorg/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253766117,"owners_count":21960847,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["lua","neorg","neovim","neovim-plugin","nvim","org-mode","organization"],"created_at":"2024-07-30T20:01:22.211Z","updated_at":"2026-04-09T04:01:02.724Z","avatar_url":"https://github.com/nvim-neorg.png","language":"Lua","readme":"\u003cdiv align=\"center\"\u003e\n\n\u003cimg src=\"res/neorg.svg\" width=300\u003e\n\n# Neorg - An Organized Future\n\n\u003ca href=\"https://neovim.io\"\u003e ![Neovim](https://img.shields.io/badge/Neovim%200.10+-brightgreen?style=for-the-badge) \u003c/a\u003e\n\u003ca href=\"https://chat.neorg.org\"\u003e ![Zulip](https://img.shields.io/badge/zulip-join-6492fe?style=for-the-badge\u0026logo=zulip) \u003c/a\u003e\n\u003ca href=\"https://discord.gg/T6EgTAX7ht\"\u003e ![Discord](https://img.shields.io/badge/discord-join-7289da?style=for-the-badge\u0026logo=discord) \u003c/a\u003e\n\u003ca href=\"/LICENSE\"\u003e ![License](https://img.shields.io/badge/license-GPL%20v3-brightgreen?style=for-the-badge)\u003c/a\u003e\n\u003ca href=\"https://dotfyle.com/plugins/nvim-neorg/neorg\"\u003e ![Usage](https://dotfyle.com/plugins/nvim-neorg/neorg/shield?style=for-the-badge) \u003c/a\u003e\n\nYour New Life Organization Tool - All in Lua\n\n[Tutorial](#-tutorial)\n•\n[Roadmap](/ROADMAP.md)\n•\n[Installation](#-installation)\n•\n[Further Learning](#-further-learning)\n\u003cbr\u003e\n[Credits](#credits)\n•\n[Support](#support)\n\n\u003c/div\u003e\n\n\u003cdiv align=\"center\"\u003e\n\n\u003cbr\u003e\n\n**: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.**\n\n## Summary\n\n\u003c/div\u003e\n\nNeorg (_Neo_ - new, _org_ - organization) is a Neovim plugin designed to reimagine organization as you know it.\nGrab some coffee, start writing some notes, let your editor handle the rest.\n\n### What is Neorg?\n\nNeorg is an all-encompassing tool based around structured note taking, project and task management, time\ntracking, slideshows, writing typeset documents and much more. The premise is that all of these features are\nbuilt on top of a single base file format (`.norg`), which the user only has to learn once to gain access to\nall of Neorg's functionality.\n\nNot only does this yield a low barrier for entry for new users it also ensures that all features are integrated with each\nother and speak the same underlying language. The file format is built to be expressive and easy to parse,\nwhich also makes `.norg` files easily usable anywhere outside of Neorg itself.\n\nA good way of thinking about Neorg is as a plaintext environment which can be adapted to a variety of use cases.\nIf a problem can be represented using raw text, it can be solved using Neorg.\n\n###### :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.\n\n## 🌟 Tutorial\n\nA video tutorial may be found on Youtube:\n\n\u003cdiv\u003e\n\n\u003ca href=\"https://www.youtube.com/watch?v=NnmRVY22Lq8\u0026list=PLx2ksyallYzVI8CN1JMXhEf62j2AijeDa\u0026index=1\"\u003e\n \u003cimg src=\"https://img.youtube.com/vi/NnmRVY22Lq8/0.jpg\" style=\"width:75%;\"\u003e\n\u003c/a\u003e\n\n\u003c/div\u003e\n\n## 📦 Installation\n\nNeorg's setup process is slightly more complex than average, so we encourage you to be patient :)\n\n**Neorg requires Neovim 0.10 or above to function. After you're done with the\ninstallation process, run `:checkhealth neorg` to see if everything's\ncorrect!**\n\n### `neorg-kickstart`\n\nNot bothered to set up Neovim on your own? Check out our [kickstart config](https://github.com/nvim-neorg/neorg/wiki/Kickstart)\nwhich will get you up and running with Neorg without any prior Neovim configuration knowledge.\n\n### `rocks.nvim`\n\nOne way of installing Neorg is via [rocks.nvim](https://github.com/nvim-neorocks/rocks.nvim).\n\n\u003cdetails\u003e\n\u003csummary\u003eInstallation snippet.\u003c/summary\u003e\n\n- Run `:Rocks install rocks-config.nvim` (if you don't have it already!).\n- Run `:Rocks install neorg`.\n- 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:\n  ```lua\n  require(\"neorg\").setup()\n  ```\n\n\u003c!-- TODO: rewrite this section once a new luarocks release is made, as it will automatically download nvim-treesitter-legacy-api as a dependency --\u003e\nFor the time being you also need `nvim-treesitter` installed.\n- `:Rocks install nvim-treesitter-legacy-api`\n- Just like the `neorg.lua` file, create a `lua/plugins/treesitter.lua` file and place the following content inside:\n  ```lua\n  require(\"nvim-treesitter.configs\").setup({\n    highlight = {\n      enable = true,\n    },\n  })\n  ```\n\nThe last three steps will eventually not be required to run Neorg.\n\n\u003c/details\u003e\n\n### `lazy.nvim`\n\nTo install Neorg via lazy, first ensure that you have `luarocks` installed on your system.\nOn Linux/Mac, this involves installing using your system's package manager. On Windows, consider\nthe [Lua for Windows](https://github.com/rjpcomputing/luaforwindows) all-in-one package.\n\n\u003cdetails\u003e\n\u003csummary\u003eClick for installation snippet.\u003c/summary\u003e\n\n```lua\n{\n    \"nvim-neorg/neorg\",\n    lazy = false, -- Disable lazy loading as some `lazy.nvim` distributions set `lazy = true` by default\n    version = \"*\", -- Pin Neorg to the latest stable release\n    config = true,\n}\n```\n\nWhile lazy [supports lazy-loading upon specific commands and\nfiletypes](https://lazy.folke.io/spec#spec-lazy-loading), it can cause neorg to load incorrectly,\nleading to a 'broken' plugin. Lazy load at your own risk, and disable lazy loading as your first\ndebugging step.\n\n\u003c/details\u003e\n\n### `packer.nvim`\n\nNeorg can be installed purely via luarocks on packer, pulling in all required dependencies in the process.\n\nIt is not recommended to use packer as it is now unmaintained.\n\n\u003cdetails\u003e\n\u003csummary\u003eClick for installation snippet.\u003c/summary\u003e\n\n```lua\nuse {\n  \"nvim-neorg/neorg\",\n  rocks = { \"lua-utils.nvim\", \"nvim-nio\", \"nui.nvim\", \"pathlib.nvim\", \"nvim-treesitter-legacy-api\" },\n  tag = \"*\", -- Pin Neorg to the latest stable release\n  config = function()\n      require(\"neorg\").setup()\n  end,\n}\n```\n\n\u003c/details\u003e\n\n### Other Plugin Managers\n\nBecause of the complexities of `luarocks`, we are choosing not to support other plugin managers for the time\nbeing. It is actively on our TODO list, however!\n\n## 📚 Further Learning\n\nAfter 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)!\n\n## Credits\n\nMassive shoutouts go to all the contributors actively working on the project together to form a fantastic\nintegrated workflow:\n\n- [mrossinek](https://github.com/mrossinek) - for basically being my second brain when it comes to developing new features\n  and adding new syntax elements\n- [danymat](https://github.com/danymat) - for creating the excellent foundations for the up and coming GTD system\n\nAnd an extra thank you to:\n\n- [Binx](https://github.com/dvchoudh) - for making that gorgeous logo for free!\n- [bandithedoge](https://github.com/bandithedoge) - for converting the PNG version of the logo into SVG form\n\n## Support\n\nLove what I do? Want to see more get done faster? Want to support future projects? Any sort of support is always\nheartwarming and fuels the urge to keep going :heart:. You can show support here:\n\n- [Buy me a coffee!](https://buymeacoffee.com/vhyrro)\n- [Support me via Github Sponsors](https://github.com/sponsors/vhyrro)\n- [Support me on Patreon](https://patreon.com/vhyrro)\n\nImmense thank you to all of the sponsors of my work!\n\n\u003cdiv align=\"center\"\u003e\n\n\u003c!-- sponsors --\u003e\u003ca href=\"https://github.com/molleweide\"\u003e\u003cimg src=\"https://github.com/molleweide.png\" width=\"60px\" alt=\"molleweide\" /\u003e\u003c/a\u003e\u0026nbsp;\u0026nbsp;\u0026nbsp;\u003ca href=\"https://github.com/danymat\"\u003e\u003cimg src=\"https://github.com/danymat.png\" width=\"60px\" alt=\"danymat\" /\u003e\u003c/a\u003e\u0026nbsp;\u0026nbsp;\u0026nbsp;\u003ca href=\"https://github.com/jgregoire\"\u003e\u003cimg src=\"https://github.com/jgregoire.png\" width=\"60px\" alt=\"jgregoire\" /\u003e\u003c/a\u003e\u0026nbsp;\u0026nbsp;\u0026nbsp;\u003ca href=\"https://github.com/bottd\"\u003e\u003cimg src=\"https://github.com/bottd.png\" width=\"60px\" alt=\"bottd\" /\u003e\u003c/a\u003e\u0026nbsp;\u0026nbsp;\u0026nbsp;\u003ca href=\"https://github.com/kvodenicharov\"\u003e\u003cimg src=\"https://github.com/kvodenicharov.png\" width=\"60px\" alt=\"kvodenicharov\" /\u003e\u003c/a\u003e\u0026nbsp;\u0026nbsp;\u0026nbsp;\u003c!-- sponsors --\u003e\n\n\u003c/div\u003e\n","funding_links":["https://opencollective.com/neorg","https://github.com/sponsors/vhyrro","https://github.com/sponsors/danymat","https://buymeacoffee.com/vhyrro","https://patreon.com/vhyrro"],"categories":["Note Taking","Lua","Table of Contents"],"sub_categories":["Cursorline","Neovim Extensions"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnvim-neorg%2Fneorg","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnvim-neorg%2Fneorg","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnvim-neorg%2Fneorg/lists"}