zh.md

Quick Note

这是一个为Neovim设计的做笔记的插件，旨在帮助你快速创建，删除，读，改笔记。

一个笔记可以和当前的光标行，当前工作目录相关联，或者被放在全局中。因此，一个典型的使用场景就是，当你在读源码时，你可以快速地创建一个与当前光标行相关联的笔记，来记录你对当前源码感到疑惑的地方，然后继续向下看源码。当之后你想回顾你之前在那行所做的笔记的时候，只需要回到那行，打开与其关联的笔记即可。

功能/特点

所有主要功能已经实现。 新的功能会在修复潜在的Bugs，优化，和写完教程指引之后再被添加。

• 原地做笔记：无需担心中断或跳出当前工作流程去做笔记或管理笔记。只需原地创建和当前光标行，工程目录，或全局相关联的笔记。
• 在笔记间跳跃：支持快速在当前Buffer跳跃到下一个/上一个笔记。
• 列出笔记：列出你所创建的笔记。
• 删除笔记：原地删除笔记。
• 导入/导出笔记：导入/导出与当前Buffer或工作目录相关联，或被放在全局的笔记。
• Signs: sign将显示在有笔记相关联的行的左侧。
• 可携带：笔记被存放在当前工作目录的 .quicknote 目录下。

安装

使用任何你喜欢的 plugin manager 。

注意：本插件使用了 nvim-lua/plenary.nvim, 所以请确保它在你的插件依赖项中，或在你的插件列表中。

比如 lazy.nvim:

require("lazy").setup({
  { "RutaTang/quicknote.nvim", config=function()
        -- you must call setup to let quicknote.nvim works correctly
        require("quicknote").setup({})
  end
  , dependencies = { "nvim-lua/plenary.nvim"} },
})

配置

当前只有一个可选配置项，但是在之后的更新中，可能有更多的配置项可选。

require("lazy").setup({
  { "RutaTang/quicknote.nvim", config=function()
        require("quicknote").setup({
            mode = "portable" -- "portable" | "resident", default to "portable"
        })
  end
  , dependencies = { "nvim-lua/plenary.nvim"} },
})

教程

快速开始 / 基本使用

1. 打开一个文件
2. 在某一行，运行 :lua requrie('quicknote').NewNoteAtCurrentLine()。现在一个笔记就会被创建并关联到当前行。但是此时你还无法看到左侧显示的sign。
3. 在同一行，运行 :lua require('quicknote').ShowNoteSigns()。 现在就可以在左侧栏看到sign了。它代表你当前行有关联的笔记。
4. 还是在同一行，运行 :lua require('quicknote').OpenNoteAtCurrentLine()。这样，当前行所关联的笔记就会被打开，你可以查看和编辑你的笔记了。

进阶使用

1. Quicknote.nvim 是什么如何运行的？

无论是关联当前光标行的笔记，还是关联当前工作目录（CWD）或全局的笔记，都会创建一个名称为当前缓冲区或CWD的哈希路径的文件夹，我称之为“笔记目录”，它将存储所有与特定缓冲区、CWD或全局相关联的笔记（全局笔记目录没有哈希处理，仅命名为“global”）。

例如，当您在名为hello_world.lua的文件的第2行创建一个笔记时，在“数据路径”中（在“resident”模式下，它是vim.fn.stdpath（“state”）..“/quicknote”；在“portable”模式下，它是位于您的CWD根目录下的“.quicknote”），您将看到一个哈希名称的文件夹，如果您打开它，您将看到“2.md”，它是您刚刚为此文件创建的笔记，“2”表示它与第2行相关联。