[{"result":{"data":[{"id":"24b632f1-3b7f-4a60-833c-3b7b214fbd35","title":"refactor!: adapt to new injection syntax for treesitter","text":"refactor!: adapt to new injection syntax for treesitter","type":"breaking-change","createdAt":"2023-08-31T02:12:54.154Z","breakingChange":{"id":39,"postId":"24b632f1-3b7f-4a60-833c-3b7b214fbd35","pluginId":303,"externalUrl":"https://github.com/nvim-neorg/neorg/commit/064f8f65dd32f4fe728e76acfa3e4e153b121147","sha":"064f8f65dd32f4fe728e76acfa3e4e153b121147","plugin":{"id":303,"owner":"nvim-neorg","name":"neorg","type":"github","source":"awesome-neovim","category":"note-taking","link":"https://github.com/nvim-neorg/neorg","shortDescription":"Modernity meets insane extensibility. The future of organizing your life in Neovim.","createdAt":"2023-03-22T19:35:21.613Z","readme":"

\n\n

\n\n# Neorg - An Organized Future\n\n ![Neovim](https://img.shields.io/badge/Neovim%200.8+-brightgreen?style=for-the-badge) \n ![Discord](https://img.shields.io/badge/discord-join-7289da?style=for-the-badge&logo=discord) \n ![License](https://img.shields.io/badge/license-GPL%20v3-brightgreen?style=for-the-badge)\n ![Usage](https://dotfyle.com/plugins/nvim-neorg/neorg/shield?style=for-the-badge) \n\nYour New Life Organization Tool - All in Lua\n\n[Summary](#summary)\n•\n[Tutorial](#-tutorial)\n•\n[Installation](#-installationquickstart)\n•\n[Setup](#-setup)\n•\n[Usage](#-usage)\n
\n[Modules](#-modules)\n•\n[Roadmap](/ROADMAP.md)\n•\n[Philosophy](#-philosophy)\n•\n[FAQ](#-faq)\n\n

\n\n

\n\n
\n\n## Summary\n\n

\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\nTo learn more about the philosophy of the project check the [philosophy](#-philosophy) section.\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\n

\n\n\n

\n\n## 🔧 Installation/Quickstart\n\n**Neorg requires at least Neovim 0.8+ to operate.**\n\n### TL;DR\n\nFor neovim beginners who don't want to tinker with the configurations:\n\n1. Install [Meslo Nerd Font](https://github.com/ryanoasis/nerd-fonts/).\n2. Set your terminal font to \"MesloLGM Nerd Font Mono\".\n3. Make sure you have git by running `git --version`\n4. Paste the sample init.lua below to `~/.config/nvim/init.lua`\n5. Start taking notes by `nvim test.norg`\n\n\n

sample init.lua

\n\n ```lua\n -- adapted from https://github.com/folke/lazy.nvim#-installation\n\n local lazypath = vim.fn.stdpath(\"data\") .. \"/lazy/lazy.nvim\"\n if not vim.loop.fs_stat(lazypath) then\n print(vim.fn.system({\n \"git\",\n \"clone\",\n \"--filter=blob:none\",\n \"https://github.com/folke/lazy.nvim.git\",\n \"--branch=stable\",\n lazypath,\n }))\n end\n vim.opt.rtp:prepend(lazypath)\n \n vim.g.mapleader = \" \"\n \n require(\"lazy\").setup({\n \"rebelot/kanagawa.nvim\", -- neorg needs a colorscheme with treesitter support\n {\n \"nvim-treesitter/nvim-treesitter\",\n build = \":TSUpdate\",\n opts = {\n highlight = { enable = true },\n },\n config = function(_, opts)\n require(\"nvim-treesitter.configs\").setup(opts)\n end,\n },\n {\n \"nvim-neorg/neorg\",\n build = \":Neorg sync-parsers\",\n dependencies = { \"nvim-lua/plenary.nvim\" },\n config = function()\n require(\"neorg\").setup {\n load = {\n [\"core.defaults\"] = {},\n [\"core.concealer\"] = {},\n [\"core.dirman\"] = {\n config = {\n workspaces = {\n notes = \"~/notes\",\n },\n default_workspace = \"notes\",\n },\n },\n },\n }\n \n vim.wo.foldlevel = 99\n vim.wo.conceallevel = 2\n end,\n }\n })\n \n vim.cmd.colorscheme('kanagawa')\n ```\n\n

\n\n### Installation\n\nYou can install it through your favorite plugin manager:\n\n-\n

packer.nvim

\n\n ```lua\n use {\n \"nvim-neorg/neorg\",\n config = function()\n require('neorg').setup {\n load = {\n [\"core.defaults\"] = {}, -- Loads default behaviour\n [\"core.concealer\"] = {}, -- Adds pretty icons to your documents\n [\"core.dirman\"] = { -- Manages Neorg workspaces\n config = {\n workspaces = {\n notes = \"~/notes\",\n },\n },\n },\n },\n }\n end,\n run = \":Neorg sync-parsers\",\n requires = \"nvim-lua/plenary.nvim\",\n }\n ```\n\n 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.\n That means that adding `tag = \"*\"` in Packer will update to latest stable release.\n\n You can also pin Neorg to one specific version through e.g. `tag = \"2.0.0\"`.\n\n ---\n\n Want to lazy load? You can use the `ft` key to load Neorg only upon entering a `.norg` file:\n\n ```lua\n use {\n \"nvim-neorg/neorg\",\n -- tag = \"*\",\n ft = \"norg\",\n after = \"nvim-treesitter\", -- You may want to specify Telescope here as well\n config = function()\n require('neorg').setup {\n load = {\n [\"core.defaults\"] = {}, -- Loads default behaviour\n [\"core.concealer\"] = {}, -- Adds pretty icons to your documents\n [\"core.dirman\"] = { -- Manages Neorg workspaces\n config = {\n workspaces = {\n notes = \"~/notes\",\n },\n },\n },\n },\n }\n end\n }\n ```\n\n Although it's proven to work for a lot of people, you might need to take some\n additional steps depending on how your lazyloading system and/or Neovim\n config is set up.\n\n

\n\n-

vim-plug

\n\n ```vim\n Plug 'nvim-neorg/neorg' | Plug 'nvim-lua/plenary.nvim'\n ```\n\n You can then put this initial configuration in your `init.vim` file:\n\n ```vim\n lua << EOF\n require('neorg').setup {\n load = {\n [\"core.defaults\"] = {}, -- Loads default behaviour\n [\"core.concealer\"] = {}, -- Adds pretty icons to your documents\n [\"core.dirman\"] = { -- Manages Neorg workspaces\n config = {\n workspaces = {\n notes = \"~/notes\",\n },\n },\n },\n },\n }\n EOF\n ```\n\n

\n-

lazy.nvim

\n\n ```lua\n require(\"lazy\").setup({\n {\n \"nvim-neorg/neorg\",\n build = \":Neorg sync-parsers\",\n dependencies = { \"nvim-lua/plenary.nvim\" },\n config = function()\n require(\"neorg\").setup {\n load = {\n [\"core.defaults\"] = {}, -- Loads default behaviour\n [\"core.concealer\"] = {}, -- Adds pretty icons to your documents\n [\"core.dirman\"] = { -- Manages Neorg workspaces\n config = {\n workspaces = {\n notes = \"~/notes\",\n },\n },\n },\n },\n }\n end,\n },\n })\n ```\n\n

\n\n### Treesitter\n\n###### _Be sure to have [nvim-treesitter](https://github.com/nvim-treesitter/nvim-treesitter) installed on your system for this step!_\nNeorg will automatically attempt to install the parsers for you upon entering a `.norg` file if you have `core.defaults` loaded.\nA command is also exposed to reinstall and/or update these parsers: `:Neorg sync-parsers`.\n\nIt is important to note that installation via this command isn't reproducible.\nThere are a few ways to make it reproducible, but the recommended way is to set up an **update flag** for your plugin\nmanager of choice. In packer, your configuration may look something like this:\n```lua\nuse {\n \"nvim-neorg/neorg\",\n run = \":Neorg sync-parsers\", -- This is the important bit!\n config = function()\n require(\"neorg\").setup {\n -- configuration here\n }\n end,\n}\n```\n\nWith the above `run` key set, every time you update Neorg the internal parsers\nwill also be updated to the correct revision.\n\n## 📦 Setup\n\nYou've got the basic stuff out the way now, but wait! That's not all. You've installed Neorg - great! Now you have to configure it.\nBy default, Neorg does nothing, and gives you nothing. You must tell it what you care about!\n\n### Default modules\n\nNeorg runs on _modules_, which are discussed and explained in more depth later on.\nEach module provides a single bit of functionality - they can then be stacked together to form\nthe entire Neorg environment.\n\nThe most common module you'll find is the `core.defaults` module, which is basically a \"load all features\" switch.\nIt gives you the full experience out of the box.\n\nThe code snippet to enable all default modules is very straightforward:\n\n```lua\nrequire('neorg').setup {\n load = {\n [\"core.defaults\"] = {}\n }\n}\n```\n\nYou can see [here](https://github.com/nvim-neorg/neorg/wiki#default-modules) which modules are automatically required when loading `core.defaults`.\n\n## ⚙ Usage\n\nA new and official specification is in the works, we recommend reading it [here](https://github.com/nvim-neorg/norg-specs/blob/main/1.0-specification.norg).\nYou can view a summary directly in your neovim instance by running `:h neorg` if you don't like reading a lot!\n\nAfterwards it's as simple as hopping into a `.norg` file and typing away.\n\nA good first step is to require the `core.dirman` module, it'll help you manage Neorg workspaces.\nWorkspaces are basically isolated directories that you can jump between:\n\n```lua\nrequire('neorg').setup {\n load = {\n [\"core.defaults\"] = {},\n [\"core.dirman\"] = {\n config = {\n workspaces = {\n work = \"~/notes/work\",\n home = \"~/notes/home\",\n }\n }\n }\n }\n}\n```\n\nChanging workspaces is easy, just do `:Neorg workspace work`, where `work` is the name of your workspace.\nVoila!\n\n#### It works, cool! What are the next steps?\n\nWe recommend you add some core modules that can greatly improve your experience, such as:\n\n- Using the concealer module to enable icons (`core.concealer`)\n- Setting up a completion engine (`core.completion`)\n\nSetting these up is discussed in the wiki, so be sure to check there!\n\n**You're now basically set**! The rest of this README will be additional information, so keep reading\nif you care about what makes Neorg tick, or you want to genuinely get good at using it.\n\n## 🥡 Modules\n\nAs you saw previously, we loaded `core.defaults` and recommended that you load `core.dirman`.\nAs you probably know those are modules. But what are they, exactly?\n\nModules are basically isolated bits of code that provide a specific subset of features. They can be docked into\nthe environment at any time and can be essentially stacked together like lego bricks!\nThey can bind themselves to events and callbacks and communicate with each other.\n\nTo require a module, just do:\n\n```lua\nrequire('neorg').setup {\n load = {\n -- Require the module with the default configurations for it\n [\"your.required.module\"] = {},\n\n -- Require the module, and override the configurations (with the \"config\" table)\n [\"your.required.module\"] = {\n config = {\n some_option = true\n }\n }\n }\n}\n```\n\nAs always, for a little more info you can consult the wiki page [here](https://github.com/nvim-neorg/neorg/wiki/#module-naming-convention).\nTo know which configurations are provided by default for a module, just click on their link: you'll go to the module page in the [wiki](https://github.com/nvim-neorg/neorg/wiki).\n\n### Core Modules\n\n[Here](https://github.com/nvim-neorg/neorg/wiki#default-modules) is a list of core modules that aren't part of `core.defaults` and can be added\nindividually by you.\n\nFeel free to try by adding them to your Neorg setup.\n\n### External Modules\n\nUsers can contribute and create their own modules for Neorg.\nTo use them, just download the plugin with your package manager, for instance with Packer:\n\n```lua\nuse {\n \"nvim-neorg/neorg\",\n requires = \"john-cena/cool-neorg-plugin\",\n}\n```\n\nAfter that it's as easy as loading the exposed module normally:\n\n```lua\nrequire('neorg').setup {\n load = {\n [\"cool.module\"] = {},\n }\n}\n```\n\nA comprehesive list of community made modules can be found [in the awesome-neorg repo](https://github.com/NTBBloodbath/awesome-neorg)!\n\n## ❓ Philosophy\n\nOur goals are fairly simple:\n\n1. Revise the org format: simple, extensible, unambiguous. Will make you feel right at home. Alternate markup formats have several flaws, but the most\n notable one is the requirement for **complex and slow parsers**.\n What if we told you it's possible to alleviate those problems, all whilst keeping that familiar feel?\n Enter the `.norg` file format, whose specification can be found [here](https://github.com/nvim-neorg/norg-specs/blob/main/1.0-specification.norg).\n The cross between all the best things from org and the best things from markdown, revised and merged into one.\n\n2. Keybinds that _make sense_: vim's keybind philosophy is unlike any other, and we want to keep that vibe.\n Keys form a \"language\", one that you can speak, not one that you need to learn off by heart.\n\n3. Infinite extensibility: no, that isn't a hyperbole. We mean it. Neorg is built upon an insanely modular and\n configurable backend - keep what you need, throw away what you don't care about. Use the defaults or change 'em.\n You are in control of what code runs and what code doesn't run!\n\n4. Logic: everything has a reason, everything has logical meaning. If there's a feature, it's there because it's necessary, not because\n two people asked for it.\n If something has a more niche use case, it should be documented.\n\n## 📚 FAQ\n\nThe wiki is the go-to place if you need answers to anything Neorg-related. Usage, Keybinds, User Callbacks, Modules, Events?\nIt's all there, so we recommend you seriously go [read it](https://github.com/nvim-neorg/neorg/wiki)!\n\n## Troubleshooting\n\nIf you feel that you're in trouble or some component like Treesitter is not working check the\n[Dependencies.md](https://github.com/nvim-neorg/neorg/wiki/Dependencies) file for many common issues\nunrelated to the Neorg core.\n\n## Contributing\n\nHave an idea? An improvement to existing functionality? Feedback in general?\n\nWe seriously recommend you join our [discord](https://discord.gg/T6EgTAX7ht) to hang out and chat about your ideas,\nplus that you read the [CONTRIBUTING.md](docs/CONTRIBUTING.md) file for more info about developer-related stuff!\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

\n\n $\"vsedov\"$ $\"bR3iN\"$ $\"skbolton\"$ $\"dimas-cyriaco\"$ $\"molleweide\"$ $\"theherk\"$ $\"Gwenillia\"$ $\"purepani\"$ \n\n

\n","dotfyleShieldAddedAt":"2023-07-21T02:28:46.074Z","stars":4973,"lastSyncedAt":"2023-11-28T02:21:30.518Z","addedLastWeek":1}}}]}}]