{"id":13451642,"url":"https://github.com/vimwiki/vimwiki","last_synced_at":"2025-05-11T03:43:37.043Z","repository":{"id":5499103,"uuid":"6698053","full_name":"vimwiki/vimwiki","owner":"vimwiki","description":"Personal Wiki for Vim","archived":false,"fork":false,"pushed_at":"2024-12-01T05:19:54.000Z","size":6492,"stargazers_count":9058,"open_issues_count":226,"forks_count":634,"subscribers_count":108,"default_branch":"dev","last_synced_at":"2025-05-11T03:43:32.957Z","etag":null,"topics":["hacktoberfest","personal-organizer","vim","vim-plugin","vimwiki","wiki"],"latest_commit_sha":null,"homepage":"http://vimwiki.github.io/","language":"Vim Script","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vimwiki.png","metadata":{"files":{"readme":"README-cn.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2012-11-15T01:51:51.000Z","updated_at":"2025-05-09T12:38:01.000Z","dependencies_parsed_at":"2023-10-16T23:09:30.444Z","dependency_job_id":"5d06cfa7-4b82-4cda-83c8-af9bf7c45076","html_url":"https://github.com/vimwiki/vimwiki","commit_stats":{"total_commits":1029,"total_committers":161,"mean_commits":6.391304347826087,"dds":0.7687074829931972,"last_synced_commit":"72792615e739d0eb54a9c8f7e0a46a6e2407c9e8"},"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vimwiki%2Fvimwiki","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vimwiki%2Fvimwiki/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vimwiki%2Fvimwiki/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vimwiki%2Fvimwiki/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vimwiki","download_url":"https://codeload.github.com/vimwiki/vimwiki/tar.gz/refs/heads/dev","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253514552,"owners_count":21920334,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hacktoberfest","personal-organizer","vim","vim-plugin","vimwiki","wiki"],"created_at":"2024-07-31T07:00:57.658Z","updated_at":"2025-05-11T03:43:37.016Z","avatar_url":"https://github.com/vimwiki.png","language":"Vim Script","readme":"VimWiki —— Vim 个人 Wiki 插件\n==============================================================================\n\n[English](README.md)\n\n![screenshot1](doc/screenshot_1.png)\n![screenshot2](doc/screenshot_2.png) *\n\n介绍\n------------------------------------------------------------------------------\n\nVimwiki 是 Vim 中的个人 Wiki —— 一组链接起来的、有独特语法高亮的文本文件。\n\n通过 Vimwiki，你可以:\n\n * 组织笔记和想法\n * 管理待办事项\n * 编写文档\n * 坚持写日记\n * 将这一切导出成 HTML 网页\n\n马上开始！按下 `\u003cLeader\u003eww`（通常是 `\\ww`）进入作为目录页的 wiki 文件，这个文件默认存放在 `~/vimwiki/index.wiki`。\n\n在该文件中输入以下示例：\n\n    = 我的个人知识库 =\n        * 任务列表 -- _昨天_ 就该完成的事！！！\n        * Gutenberg 计划 -- 好书给我力量。\n        * 草稿 -- 临时记录一些东西。\n\n把光标移到 `任务` 二字上，按 Enter（回车）创建链接。按下后，`任务`二字会变成 `[[任务]]` —— 这是一个 Vimwiki 链接。再次按 Enter 即可进入这个链接（打开新的 wiki 文件）。编辑这个新文件，保存，然后按 Backspace（退格）就能回到目录页。\n\n如果 Vimwiki 链接长度不止一个单词（指的是英文单词），只需在 Visual 模式选择这段文本后按 Enter 即可。用上面的 `Gutenberg 计划` 试试吧。最终结果是这样：\n\n    = 我的个人知识库 =\n        * [[任务列表]] -- _昨天_ 就该完成的事！！！\n        * [[Gutenberg 计划]] -- 好书给我力量。\n        * 草稿 -- 临时记录一些东西。\n\n\n基本标记\n------------------------------------------------------------------------------\n\n    = 一级标题 =\n    == 二级标题 ==\n    === 三级标题 ===\n\n\n    *bold* -- 粗体文本\n    _italic_ -- 斜体文本\n    （应用于句中的汉字文本时，必须在标记前后加空格，例如：一段 *中文* 文本）\n\n    [[wiki link]] -- wiki 链接\n    [[wiki link|description]] -- 带有描述文本的 wiki 链接\n\n\n列表：\n\n    * bullet list item 1（无编号列表）\n        - bullet list item 2\n        - bullet list item 3\n            * bullet list item 4\n            * bullet list item 5\n    * bullet list item 6\n    * bullet list item 7\n        - bullet list item 8\n        - bullet list item 9\n\n    1. numbered list item 1（有编号列表）\n    2. numbered list item 2\n        a) numbered list item 3\n        b) numbered list item 4\n\n\n更多格式说明，请阅 `:h vimwiki-syntax`\n\n\n键位绑定\n------------------------------------------------------------------------------\n\nnormal 模式:\n\n * `\u003cLeader\u003eww` -- 打开默认的 wiki 目录文件\n * `\u003cLeader\u003ewt` -- 在新标签（Tab）中打开 wiki 目录文件\n * `\u003cLeader\u003ews` -- 在多个 wiki 中选择并打开该 wiki 的目录文件\n * `\u003cLeader\u003ewd` -- 删除当前 wiki 文件\n * `\u003cLeader\u003ewr` -- 重命名当前 wiki 文件\n * `\u003cEnter\u003e` -- 创建或打开 wiki 链接\n * `\u003cShift-Enter\u003e` -- 先上下分屏再打开 wiki 链接（若非链接则先创建）\n * `\u003cCtrl-Enter\u003e` -- 先左右分屏再打开 wiki 链接（若非链接则先创建）\n * `\u003cBackspace\u003e` -- 返回之前浏览的 wiki 文件\n * `\u003cTab\u003e` -- 跳到本文件中下一个 wiki 链接\n * `\u003cShift-Tab\u003e` -- 跳到本文件中上一个 wiki 链接\n\n更多快捷键说明，请阅 `:h vimwiki-mappings`\n\n\n命令\n------------------------------------------------------------------------------\n\n * `:Vimwiki2HTML` -- 将当前 wiki 文件转换成 HTML 网页\n * `:VimwikiAll2HTML` -- 把所有 wiki 文件转换成 HTML 网页\n * `:help vimwiki-commands` -- 显示全部命令\n\n\n安装\n==============================================================================\n\n准备工作\n------------------------------------------------------------------------------\n\n确保在 `vimrc` 中加入了以下设置：\n\n    set nocompatible\n    filetype plugin on\n    syntax on\n\n没有这些设置，Vimwiki 将无法正常工作。\n\n通过 [Vim packages](http://vimhelp.appspot.com/repeat.txt.html#packages) 安装（Vim 7.4.1528 后）\n------------------------------------------------------------------------------\n\n    git clone https://github.com/vimwiki/vimwiki.git ~/.vim/pack/plugins/start/vimwiki\n\n通过 [Pathogen](http://www.vim.org/scripts/script.php?script_id=2332) 安装\n------------------------------------------------------------------------------\n\n    cd ~/.vim\n    mkdir bundle\n    cd bundle\n    git clone https://github.com/vimwiki/vimwiki.git\n\n通过 [Vim-Plug](https://github.com/junegunn/vim-plug) 安装\n------------------------------------------------------------------------------\n\n在 `vimrc` 中加入以下插件设置：\n\n    Plug 'vimwiki/vimwiki'\n\n然后运行 `:PlugInstall`。\n\n通过 [Vundle](https://github.com/VundleVim/Vundle.vim) 安装\n------------------------------------------------------------------------------\n\n在 `vimrc` 中加入 `Plugin 'vimwiki/vimwiki'`，然后执行：\n\n    vim +PluginInstall +qall\n\n或者下载 [zip 压缩包](https://github.com/vimwiki/vimwiki/archive/master.zip)然后解压到 `~/.vim/bundle/` 目录下。\n\n安装后，启动 Vim 并执行 `:Helptags` 以及 `:help vimwiki`，检查安装是否成功。\n\n\n获取帮助\n==============================================================================\n\n遇到问题？在 Freenode 的 IRC 频道 `#vimwiki`（[网页聊天](https://webchat.freenode.net/?channels=#vimwiki)）提问，或者发送问题到[邮件列表](https://groups.google.com/forum/#!forum/vimwiki)上吧。\n\n\n----\n\\* 前面截图中用的是 [solarized 配色方案](https://github.com/altercation/vim-colors-solarized)以及 [lightline](https://github.com/itchyny/lightline.vim) 插件。\n","funding_links":[],"categories":["Vim script","Vim Script","Open Source","hacktoberfest","plugins for writing","Removed Projects","General Tools"],"sub_categories":["Editor Plugin","Uncategorized","Wiki Builder"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvimwiki%2Fvimwiki","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvimwiki%2Fvimwiki","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvimwiki%2Fvimwiki/lists"}