vimwiki
v2024.01.24
中文
Vimwiki是VIM的个人Wiki - 许多具有自己的语法突出显示的链接文本文件。有关使用Vimwiki建立的示例网站，请参见Vimwiki Wiki！
如果您有兴趣贡献，请参见本节。
使用Vimwiki，您可以：
要快速启动，请按<Leader>ww （默认为ww ）进入您的索引Wiki文件。默认情况下，它位于~/vimwiki/index.wiki中。请参阅:h vimwiki_list注册了另一条路径/Wiki。
用以下示例将其馈送：
= My knowledge base =
* Tasks -- things to be done _yesterday_!!!
* Project Gutenberg -- good books are power.
* Scratchpad -- various temporary stuff.
将光标放在Tasks上，然后按Enter创建链接。一旦按下， Tasks将成为[[Tasks]] - vimwiki链接。再次按Enter打开它。编辑文件，保存它，然后按BackSpace跳回您的索引。
Vimwiki链接可以由多个单词构建。只需视觉选择要链接的单词，然后按Enter。尝试使用Project Gutenberg 。结果应该看起来像：
= My knowledge base =
* [[Tasks]] -- things to be done _yesterday_!!!
* [[Project Gutenberg]] -- good books are power.
* Scratchpad -- various temporary stuff.
Vimwiki已在VIM> = 7.3上进行了测试。它可能会在较旧的版本上使用，但不会得到正式支持。众所周知，它可以在Neovim上工作，尽管它可能有新维姆特定的错误。
确保您在VIMRC文件中具有这些设置：
set nocompatible
filetype plugin on
syntax on没有他们，Vimwiki将无法正常工作。
git clone https://github.com/vimwiki/vimwiki.git ~ /.vim/pack/plugins/start/vimwiki
# to generate documentation i.e. ':h vimwiki'
vim -c ' helptags ~/.vim/pack/plugins/start/vimwiki/doc ' -c quit
笔记：
:h helptags 。:h packages 。 cd ~ /.vim
mkdir bundle
cd bundle
git clone https://github.com/vimwiki/vimwiki.git
将以下内容添加到VIMRC中的插件 - 配置：
Plug ' vimwiki/vimwiki '
然后运行:PlugInstall 。
将Plugin 'vimwiki/vimwiki'添加到您的vimrc文件中并运行：
vim +PluginInstall +qall
下载zip存档并在~/.vim/bundle/中提取它
然后启动VIM，运行:Helptags ，然后:help vimwiki验证其已安装。
= Header1 =
== Header2 ==
=== Header3 ===
*bold* -- bold text
_italic_ -- italic text
[[wiki link]] -- wiki link
[[wiki link|description]] -- wiki link with description
* bullet list item 1
- bullet list item 2
- bullet list item 3
* bullet list item 4
* bullet list item 5
* bullet list item 6
* bullet list item 7
- bullet list item 8
- bullet list item 9
1. numbered list item 1
2. numbered list item 2
a) numbered list item 3
b) numbered list item 4
有关其他语法元素，请参见:h vimwiki-syntax
- [.] Partially completed item with sub-tasks
- [X] Completed sub-task
- [ ] Incomplete sub-task
- [ ] Other incomplete sub-task
- [ ] Incomplete item
注意：您的终端可能会阻止捕获以下列出的一些默认绑定。请参阅:h vimwiki-local-mappings如果您遇到问题，请提供有关替代绑定的建议。
<Leader>ww打开默认Wiki索引文件。<Leader>wt在新选项卡中打开默认Wiki索引文件。<Leader>ws选择并打开Wiki索引文件。<Leader>wd删除您所在的Wiki文件。<Leader>wr重命名您所在的Wiki文件。<Enter> - 关注/创建Wiki链接。<Shift-Enter> - 拆分并关注/创建Wiki链接。<Ctrl-Enter> - 垂直拆分并关注/创建Wiki链接。<Backspace> - 返回到父（上一个）Wiki链接。<Tab> - 找到下一个Wiki链接。<Shift-Tab> - 查找以前的Wiki链接。 请参阅以下内容的完整文档:h vimwiki-mappings以查看更多绑定。
:Vimwiki2HTML将当前的Wiki链接转换为HTML。:VimwikiAll2HTML将所有Wiki链接转换为HTML。:help vimwiki-commands列出所有命令。:help vimwiki -Vimwiki将军帮助文档。 Vimwiki目前带有3种语法：Vimwiki（默认），Markdown（Markdown）和Mediawiki（Media）。其中，最好支持本机Vimwiki语法，其次是Markdown。没有对Mediawiki做出的承诺。
注意：只有内置HTML转换器的默认语法发行。有关Markdown或Mediawiki，请参见:h vimwiki-option-custom_wiki2html 。这里提供了一些示例和第三方工具。
如果您希望使用Markdown或MediaWiki语法，请在.vimrc中设置以下选项：
let g: vimwiki_list = [{ ' path ' : ' ~/vimwiki/ ' ,
' syntax ' : ' markdown ' , ' ext ' : ' md ' }]
此选项将作为Vimwiki的一部分（检查set filetype? ）将您系统中的所有Markdown文件视为。添加
let g: vimwiki_global_ext = 0到您的.vimrc将Vimwiki的操作限制为g:vimwiki_list中列出的那些路径。其他Markdown文件不会被视为Wiki页面。参见G：vimwiki_global_ext。
如果要关闭对其他扩展程序的支持（例如，禁用不小心创建新的Wiki并为普通Markdown文件链接），请在Packadd Vimwiki之前在.vimrc中设置以下选项：
let g: vimwiki_ext2syntax = {}参见G：Vimiki_ext2syntax
GitHub问题是提高错误报告或功能请求的主要方法。
其他资源：
Vimwiki有很多用户，但只有很少的经常性开发人员或帮助社区的人。因此，感谢您的帮助。每个人都可以帮忙！有关如何提供帮助的信息，请参见＃625。
另外，看一下贡献。md和design_notes.md
麻省理工学院许可证
版权（C）2008-2010 Maxim Kim 2013-2017 Daniel Schemala
特此免费授予获得此软件副本和相关文档文件副本（“软件”）的任何人，以无限制处理该软件，包括无限制的使用权，复制，复制，修改，合并，合并，发布，分发，分发，分发，订婚，和/或允许软件的副本，并允许对以下条件提供以下条件，以下是以下条件。
上述版权通知和此许可通知应包含在软件的所有副本或大量部分中。
该软件是“原样”提供的，没有任何形式的明示或暗示保证，包括但不限于适销性，特定目的的适用性和非侵权的保证。在任何情况下，作者或版权持有人都不应对任何索赔，损害赔偿或其他责任责任，无论是在合同，侵权的诉讼中还是其他责任，是由软件，使用或与软件中的使用或其他交易有关的。
