Neorg - 有组织的未来

您的全新生活组织工具 - 全部使用Lua

教程 • 路线图 • 安装 • 进一步学习 <br> 致谢 • 支持

</div> <div align="center"> <br>

:warning: Neorg 9.0.0 引入了一些重大更改！请查看这篇博文了解变更内容。

概述

</div>

Neorg（Neo - 新的，org - 组织）是一个旨在重新定义您所知的组织方式的Neovim插件。拿杯咖啡，开始写些笔记，让您的编辑器处理剩下的事情。

Neorg是什么？

Neorg是一个全面的工具，基于结构化笔记记录、项目和任务管理、时间追踪、幻灯片、编写排版文档等功能。其前提是所有这些功能都建立在一个单一的基础文件格式（.norg）之上，用户只需学习一次就可以使用Neorg的所有功能。

这不仅为新用户提供了低门槛的入口，还确保了所有功能都是相互集成的，并使用相同的底层语言。该文件格式设计得富有表现力且易于解析，这也使得.norg文件在Neorg之外的任何地方都易于使用。

将Neorg视为一个可以适应各种用例的纯文本环境是一个很好的理解方式。如果一个问题可以用原始文本表示，那么就可以使用Neorg来解决。

:exclamation: 重要提示：Neorg是年轻的软件。我们认为它是稳定的，但请做好偶尔出现工作流程变更的准备。确保固定您想使用的Neorg版本，只在准备好时更新。

🌟 教程

可以在YouTube上找到视频教程：

📦 安装

Neorg的安装过程比平均水平稍微复杂一些，所以我们鼓励您保持耐心 :)

Neorg需要Neovim 0.10或以上版本才能运行。完成安装过程后，运行:checkhealth neorg来检查一切是否正确！

`rocks.nvim`

安装Neorg的一种方式是通过rocks.nvim。

<details> <summary>安装代码片段。</summary>

运行:Rocks install rocks-config.nvim（如果您还没有安装的话！）。
运行:Rocks install neorg。
从您的配置根目录（类Unix系统上为~/.config/nvim/），创建一个lua/plugins/neorg.lua文件并在其中放置以下内容：
```
require("neorg").setup()
```

目前您还需要安装nvim-treesitter，但该插件尚未在luarocks上提供。为了解决这个问题，您还需要运行以下命令：

:Rocks install rocks-git.nvim
:Rocks install nvim-treesitter/nvim-treesitter
就像neorg.lua文件一样，创建一个lua/plugins/treesitter.lua文件并在其中放置以下内容：
```
require("nvim-treesitter.configs").setup({
  highlight = {
    enable = true,
  },
})
```

最后三个步骤最终将不再需要运行Neorg。

</details>

`neorg-kickstart`

不想自己设置Neovim？查看我们的kickstart配置，它将帮助您在没有任何先前Neovim配置知识的情况下快速启动并运行Neorg。

`lazy.nvim`

要通过lazy安装Neorg，首先确保您的系统上已安装luarocks。在Linux/Mac上，这涉及使用系统的包管理器进行安装。在Windows上，考虑使用 Lua for Windows一体化包。

<details> <summary>点击查看安装代码片段。</summary>

{
    "nvim-neorg/neorg",
    lazy = false, -- 禁用延迟加载，因为一些`lazy.nvim`发行版默认设置`lazy = true`
    version = "*", -- 将Neorg固定到最新的稳定版本
    config = true,
}

</details>

`packer.nvim`

Neorg可以完全通过packer上的luarocks安装，在此过程中拉取所有必需的依赖项。

不推荐使用packer，因为它现在已不再维护。

<details> <summary>点击查看安装代码片段。</summary>

use {
  "nvim-neorg/neorg",
  rocks = { "lua-utils.nvim", "nvim-nio", "nui.nvim", "plenary.nvim", "pathlib.nvim" },
  tag = "*", -- 将Neorg固定到最新的稳定版本
  config = function()
      require("neorg").setup()
  end,
}