简介

这是一个用于编写和维护个人维基的 Vim 和 neovim 插件。该插件最初基于 vimwiki，但它主要是从头开始编写的，并且基于"只做一件事并做好它"的理念。

本 README 文件包含如何入门的基本信息，以及可用功能的列表。有关更多详细信息，请阅读完整文档。

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

注意：wiki.vim 需要 Vim 9.1 或 Neovim 0.9.5。

目录

• 快速入门
• 功能
• 致谢
• 替代方案

快速入门

安装

如果你使用 vim-plug，那么在你的 vimrc 文件中添加以下行：

Plug 'lervag/wiki.vim'

或者使用其他插件管理器：

• vundle
• neobundle
• pathogen

使用方法

以下是入门的基本步骤：

1. 创建一个用于存储维基文件的维基目录，例如 ~/wiki。

2. 在你的 vimrc 文件中添加以下内容：

   let g:wiki_root = '~/wiki'

3. 现在你可以使用 <leader>ww 打开索引文件（默认为 index.wiki），并开始根据需要添加笔记。

请同时阅读文档中的"指南"部分。

功能

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

致谢

如果没有 vimwiki，这个插件就不会存在。因此，我要感谢那些开发和维护 vimwiki 的聪明人，感谢他们的灵感和想法。

替代方案

欢迎考虑任何可用的替代方案。可能还有更多，但以下是我所知道的：

• Vimwiki
• neorg
• tdo.nvim
• notes.nvim