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
特此免費授予獲得此軟件副本和相關文檔文件副本（“軟件”）的任何人，以無限制處理該軟件，包括無限制的使用權，複製，複製，修改，合併，合併，發布，分發，分發，分發，訂婚，和/或允許軟件的副本，並允許對以下條件提供以下條件，以下是以下條件。
上述版權通知和此許可通知應包含在軟件的所有副本或大量部分中。
該軟件是“原樣”提供的，沒有任何形式的明示或暗示保證，包括但不限於適銷性，特定目的的適用性和非侵權的保證。在任何情況下，作者或版權持有人都不應對任何索賠，損害賠償或其他責任責任，無論是在合同，侵權的訴訟中還是其他責任，是由軟件，使用或與軟件中的使用或其他交易有關的。
