wiki.vim

这是一个 Vim 和 neovim 插件，用于编写和维护个人 wiki。该插件最初基于 vimwiki，但大部分是从零开始编写的，并基于更“做好一件事并把它做好”的理念。

本 README 文件包含有关如何入门的基本信息，以及可用功能的列表。有关更多详细信息，请阅读完整文档（如果插件已安装，则为 :help wiki.vim）。

[!NOTE]

wiki.vim 不是_一个_文件类型插件。它旨在与文件类型插件_一起_使用，例如专用的 Markdown 插件。建议用户阅读 :help wiki-intro-plugins 以获取与 wiki.vim 配合良好的插件列表。

[!WARNING]

wiki.vim 需要 Vim 9.1 或 Neovim 0.10！

快速入门

安装

安装插件的方法有很多。以下介绍了最常见和流行的方法。

lazy.nvim

要安装 wiki.vim，请添加一个类似于以下的插件规范：

{
  "lervag/wiki.vim",
  -- tag = "v0.10", -- uncomment to pin to a specific release
  init = function()
    -- wiki.vim configuration goes here, e.g.
  end
}

wiki.vim 主要使用 Vimscript 实现，并采用经典的 vimscript 变量约定进行配置，例如 g:wiki_OPTION_NAME。如今， Neovim 通常使用 Lua 进行配置，因此一些用户可能会感兴趣阅读 :help lua-vimscript。

vim-plug

如果你使用 vim-plug，请将以下其中一行添加到你的配置中。第一行将使用 master 分支的最新版本，而第二行将固定到一个发布标签。

Plug 'lervag/wiki.vim'
Plug 'lervag/wiki.vim', { 'tag': 'v0.10' }

其他

市面上还有许多其他插件管理器。它们通常文档完善，因此根据上述代码片段进行推断应该很直接。

用法

以下是入门的基本步骤：

创建一个用于存放 wiki 文件的目录，例如 ~/wiki。
将以下内容添加到您的 vimrc 文件中：
```
let g:wiki_root = '~/wiki'
```
现在你可以使用 <leader>ww 打开索引文件，并开始按你的意愿添加笔记。

请同时阅读 documentation 中的 Guide 部分。

功能

Wiki 功能
- 全局
  - 访问预指定 wiki 的命令（及映射）（g:wiki_root）
    - WikiIndex 打开索引
    - WikiJournal 打开日志
    - WikiPages 从所有页面列表中选择
    - WikiTags 从标签列表中选择
- 本地命令和映射，用于
  - 导航（跟随链接、返回等）
  - 重命名页面（也会更新其他页面中的链接）
  - 通过目录导航（WikiToc）
  - 创建目录（WikiTocGenerate）
  - 转换链接（从文本到链接，或在链接类型之间转换）
  - 查看 wiki 链接图
  - 显示传入链接（参见 WikiLinkIncomingToggle）
- wiki 链接和链接锚点的补全
- 文本对象
  - iu au 链接 URL
  - it at 链接文本
- 新页面模板
支持日志条目
- 使用 <c-p> 和 <c-n> 在日志中前后导航
- 支持解析日志条目以生成每周和每月摘要。解析结果需要手动编辑才能获得良好效果。
实用功能
- :WikiExport 命令，用于使用 pandoc 导出到例如 pdf
第三方支持
- ncm2: 用于嵌套补全的 SubscopeDetector

致谢

没有 vimwiki，这个插件永远不会存在。因此，我的感谢献给开发和维护 vimwiki 的聪明人，既为灵感，也为想法。

替代方案

请随意考虑众多可用的替代方案。可能还有更多，但以下是我所知道的：

wiki.vim

目录

快速入门

安装

lazy.nvim

vim-plug

其他

用法

功能

致谢

替代方案