39 Commits

Author SHA1 Message Date
Michael F. Schönitzer 79d6a1a4e2 Update version number to 2.4.1 2019-04-20 14:01:11 +02:00
Michael F. Schönitzer f105819c48 Add screen shots provided by @monkinco in PR #670
I cut the screen shots to only show features of vimwiki.
2019-04-20 13:51:15 +02:00
Rane Brown 4a9f81c54b Add info to include in help file. Issue #652 2019-04-10 21:31:23 +02:00
Rane Brown d3aade7349 Fix VimwikiShowVersion function. Closes #654.
Change a:xxx variable to l:xxx since argument variables are immutable as
of Vim patch 888. Convert the stable version number to a string prior to
printing.
2019-04-10 21:31:15 +02:00
Monkin 62d71b832a Update and format README.md 2019-04-10 21:31:02 +02:00
Rane Brown b90fbc70d9 Fix missing 'T' in syntax definition of VimwikiDelTextT
The missing 'T' character was causing strikethrough ~ characters to be
hidden within tables which is not the desired behavior. Closes #404.
2019-04-10 21:28:47 +02:00
Michael F. Schönitzer 6766c37ce0 Set release date for 2.4 2019-03-24 15:06:50 +01:00
Michael F. Schönitzer 5553cef249 Update version number 2019-03-21 23:09:36 +01:00
Michael F. Schönitzer 7fbeea2c1e Update the changelog 2019-03-21 23:06:01 +01:00
Michael F. Schönitzer 57385b29bb Update list of contributors 2019-03-21 21:52:59 +01:00
Michael F. Schönitzer d0e14dd11c Merge branch 'master' into rel-2.4-pre 2019-03-21 21:12:44 +01:00
Rane Brown a5ef478750 Improverize issue template per #513 2019-03-20 06:24:16 -06:00
Rane Brown 605604fc23 Create an issue template 2019-03-17 22:24:51 -06:00
Rane Brown 7f98bfbe4b Create a pull request template. 2019-03-17 22:06:10 -06:00
EinfachToll 54d1a997d9 Update Contributing.md 2019-03-11 21:24:19 +01:00
Michael F. Schönitzer 5ab8f8672e Add call for help and note about Riot 2019-03-09 14:49:01 +01:00
EinfachToll 1b2643ea19 Clarify the description of hl_cb_checked in the doc
Ref #605
2019-02-04 21:48:18 +01:00
EinfachToll e16dc41a50 The recommended branch to use is master, not dev 2019-02-01 17:51:41 +01:00
EinfachToll 19f1d36229 Revert "Initial commit"
This reverts commit 7699967a99.
Reason: It's wrong. In markdown, opposed to mediawiki, list items can be indented, e.g. when a
list contains a list.
2019-02-01 17:48:48 +01:00
Stefan Huber b8d0cf377d doc: Fix spelling for <Leader> 2019-02-01 17:43:05 +01:00
Nico a7160310c9 Patch for issue #585 - implement suggested improvements 2019-02-01 17:43:05 +01:00
Nicolas Brailovsky 0f38192b03 Patch for issue #585, fix anchor links for multiple extensions 2019-02-01 17:43:05 +01:00
CUI Hao (Lab) 41199e6e3b Update Chinese readme & add links to each readme 2019-02-01 17:43:05 +01:00
Fredrik Arnerup 69aa609941 Don't include trailing period in link 2019-02-01 17:43:05 +01:00
Daniel Quomsieh 72bbb1b740 fixed writing error 2019-02-01 17:43:05 +01:00
Steven Stallion 7699967a99 Initial commit 2019-02-01 17:43:05 +01:00
Michael F. Schönitzer 394efe4312 Add a command that shows the version or commit
Ref #512
2019-02-01 17:43:05 +01:00
EinfachToll ea13b0e848 Make master the recommended branch to use
Discussed in #505
2019-02-01 17:43:05 +01:00
EinfachToll daee3b4796 Fix a typo 2019-01-30 21:46:03 +01:00
Hugo Hörnquist bda3a59f91 Made headings link to themselves.
Made each heading link to itself, by placing an <a> tag inside each
<h[1-6]> tag.

Also adds class="header" to each header, allowing for the CSS rule
    .header a { ...  }
to remove all styling from the inner links, allowing the outputed
document to look like before.
2019-01-30 21:13:29 +01:00
Stefan Huber 417490f30b doc: Fix spelling for <Leader> 2019-01-29 21:49:28 +01:00
Nico 4e6db92d2c Patch for issue #585 - implement suggested improvements 2019-01-20 19:10:10 +01:00
Nicolas Brailovsky aca8c2b8cc Patch for issue #585, fix anchor links for multiple extensions 2019-01-20 19:10:10 +01:00
CUI Hao (Lab) 7ffc295094 Update Chinese readme & add links to each readme 2018-10-12 23:44:36 +02:00
Fredrik Arnerup f882cf0152 Don't include trailing period in link 2018-09-17 15:22:04 +02:00
Daniel Quomsieh f55ec31675 fixed writing error 2018-09-03 18:42:27 +02:00
Steven Stallion 9f797f6ad9 Initial commit 2018-07-21 02:04:13 +02:00
Michael F. Schönitzer 9f8b0082db Add a command that shows the version or commit
Ref #512
2018-06-12 20:55:56 +02:00
EinfachToll f60923eaa3 Make master the recommended branch to use
Discussed in #505
2018-06-06 21:27:25 +02:00
17 changed files with 393 additions and 194 deletions
+11
View File
@@ -0,0 +1,11 @@
# Issue Checks
Prior to submitting a new issue make sure to complete these steps:
1. Checkout the `dev` branch and confirm the issue is present there as well.
The `dev` branch contains fixes that may not have been merged to `master` yet.
2. Post the syntax you are using (default/mediawiki/markdown) **and** your vimwiki settings from your `.vimrc`
3. Provide a detailed description of the problem including **steps to reproduce the issue**.
4. Include the output of `:VimwikiShowVersion`.
**DELETE THIS TEMPLATE TEXT PRIOR TO SUBMITTING THE ISSUE**
+9
View File
@@ -0,0 +1,9 @@
# Pull Request Checks
1. **ALL** pull requests should be made against the `dev` branch!
2. Take a look at [CONTRIBUTING.MD](https://github.com/vimwiki/vimwiki/blob/dev/CONTRIBUTING.md)
3. Reference any related issues.
4. Provide a description of the proposed changes and any testing that was done.
5. Make sure to update the documentation in `doc/vimwiki.txt` if applicable.
**DELETE THIS TEMPLATE TEXT PRIOR TO SUBMITTING YOUR PULL REQUEST**
+20 -3
View File
@@ -6,18 +6,36 @@ https://github.com/vimwiki/vimwiki/tree/dev to see if your problem is already fi
Issues can be filed at https://github.com/vimwiki/vimwiki/issues/ . Issues can be filed at https://github.com/vimwiki/vimwiki/issues/ .
# Creating a pull request # Creating a pull request
If you want to provide a pull request on GitHub, please start from the `dev` branch, not from the If you want to provide a pull request on GitHub, please start from the `dev` branch, not from the
`master` branch. (Caution, GitHub shows `master` as the default branch from which to start a PR.) `master` branch. (Caution, GitHub shows `master` as the default branch from which to start a PR.)
Make sure to update `doc/vimwiki.txt` with the following information:
1. Update the changelog to include information on the new feature the PR introduces or the bug it
is fixing.
2. Add a help section to describe any new features or options.
2. If you are a first time contributor add your name to the list of contributors.
# More info and advice for (aspiring) core developers
- Before implementing a non-trivial feature, think twice what it means for the user. We should
always try to keep backward compatibility. If you are not sure, discuss it on GitHub.
- Also, when thinking about adding a new feature, it should be something which fits into the
overall design of Vimwiki and which a significant portion of the users may like. Keep in mind
that everybody has their own way to use Vimwiki.
- Keep the coding style consistent.
- Test your changes. Keep in mind that Vim has a ton of options and the users tons of different
setups. Take a little time to think about under which circumstances your changes could break.
# More info for (aspiring) core developers
## Git branching model ## Git branching model
- there are two branches with eternal lifetime: - there are two branches with eternal lifetime:
- `dev`: This is where the main development happens. Tasks which are done in one or only a few - `dev`: This is where the main development happens. Tasks which are done in one or only a few
commits go here directly. Always try to keep this branch in a working state, that is, if the commits go here directly. Always try to keep this branch in a working state, that is, if the
task you work on requires multiple commits, make sure intermediate commits don't make Vimwiki task you work on requires multiple commits, make sure intermediate commits don't make Vimwiki
unusable (or at least push these commits at one go). unusable (or at least push these commits at one go).
- `master`: This branches is for released states only. Whenever a reasonable set of changes has - `master`: This branch is for released states only. Whenever a reasonable set of changes has
piled up in the `dev` branch, a [release is done](#Preparing a release). After a release, piled up in the `dev` branch, a [release is done](#Preparing a release). After a release,
`dev` has been merged into `master` and `master` got exactly one additional commit in which `dev` has been merged into `master` and `master` got exactly one additional commit in which
the version number in `plugin/vimwiki.vim` is updated. Apart from these commits and the merge the version number in `plugin/vimwiki.vim` is updated. Apart from these commits and the merge
@@ -42,5 +60,4 @@ If you want to provide a pull request on GitHub, please start from the `dev` bra
forget this plan. forget this plan.
11. Tell the world. 11. Tell the world.
%% vim:tw=99 %% vim:tw=99
View File
+84 -54
View File
@@ -1,63 +1,62 @@
一个私人的维基——vim插件 VimWiki —— Vim 个人 Wiki 插件
============================================================================== ==============================================================================
[English](README.md)
![screenshot1](doc/screenshot_1.png) ![screenshot1](doc/screenshot_1.png)
![screenshot2](doc/screenshot_2.png) ![screenshot2](doc/screenshot_2.png) *
介绍 介绍
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
Vimwiki是私人维基的vim插件 -- 许多有自己代码高亮的text文件。 Vimwiki 是 Vim 中的个人 Wiki —— 一组链接起来的、有独特语法高亮的文本文件。
通过 Vimwiki,你可以: 通过 Vimwiki,你可以:
* 组织笔记和想法 * 组织笔记和想法
* 制作代办事项 * 管理待办事项
* 写文档 * 写文档
* 坚持写日记
* 将这一切导出成 HTML 网页
一个快速的开始,通常使用`<Leader>ww`(一般是`\ww`),然后创建你的index wiki文件 马上开始!按下 `<Leader>ww`(通常是 `\ww`)进入作为目录页的 wiki 文件,这个文件默认存放在 `~/vimwiki/index.wiki`
通常,它在:
~/vimwiki/index.wiki 在该文件中输入以下示例:
在这个文件,输入如下的例子: = 我的个人知识库 =
* 任务列表 -- _昨天_ 就该完成的事!!!
* Gutenberg 计划 -- 好书给我力量。
* 草稿 -- 临时记录一些东西。
= My knowledge base = 把光标移到 `任务` 二字上,按 Enter(回车)创建链接。按下后,`任务`二字会变成 `[[任务]]` —— 这是一个 Vimwiki 链接。再次按 Enter 即可进入这个链接(打开新的 wiki 文件)。编辑这个新文件,保存,然后按 Backspace(退格)就能回到目录页。
* Tasks -- things to be done _yesterday_!!!
* Project Gutenberg -- good books are power.
* Scratchpad -- various temporary stuff.
将你的光标放到`Tasks`(任务)上,并且按回车键去创建一个链接。一旦按下,`Task`将会 如果 Vimwiki 链接长度不止一个单词(指的是英文单词),只需在 Visual 模式选择这段文本后按 Enter 即可。用上面的 `Gutenberg 计划` 试试吧。最终结果是这样:
变成`[[Tasks]]` -- 一个vimwiki的链接。再按一次回车去打开它。编辑文件,保存它,
然后按backspace来返回你的index。
一个vimwiki链接可以一句话创建。只需要通过选择visual模式选择这个句子,然后按回车。 = 我的个人知识库 =
你可以通过选择`Project Gutenberg`来尝试。结果像是这个样子: * [[任务列表]] -- _昨天_ 就该完成的事!!!
* [[Gutenberg 计划]] -- 好书给我力量。
= My knowledge base = * 草稿 -- 临时记录一些东西。
* [[Tasks]] -- things to be done _yesterday_!!!
* [[Project Gutenberg]] -- good books are power.
* Scratchpad -- various temporary stuff.
基本标记 基本标记
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
= Header1 = = 一级标题 =
== Header2 == == 二级标题 ==
=== Header3 === === 三级标题 ===
*bold* -- bold text *bold* -- 粗体文本
_italic_ -- italic text _italic_ -- 斜体文本
(应用于句中的汉字文本时,必须在标记前后加空格,例如:一段 *中文* 文本)
[[wiki link]] -- wiki link [[wiki link]] -- wiki 链接
[[wiki link|description]] -- wiki link with description [[wiki link|description]] -- 带有描述文本的 wiki 链接
列表: 列表
* bullet list item 1 * bullet list item 1(无编号列表)
- bullet list item 2 - bullet list item 2
- bullet list item 3 - bullet list item 3
* bullet list item 4 * bullet list item 4
@@ -67,13 +66,13 @@ Vimwiki是私人维基的vim插件 -- 许多有自己代码高亮的text文件
- bullet list item 8 - bullet list item 8
- bullet list item 9 - bullet list item 9
1. numbered list item 1 1. numbered list item 1(有编号列表)
2. numbered list item 2 2. numbered list item 2
a) numbered list item 3 a) numbered list item 3
b) numbered list item 4 b) numbered list item 4
查看`:h vimwiki-syntax` 更多格式说明,请阅 `:h vimwiki-syntax`
键位绑定 键位绑定
@@ -81,46 +80,49 @@ Vimwiki是私人维基的vim插件 -- 许多有自己代码高亮的text文件
normal 模式: normal 模式:
* `<Leader>ww` -- 打开默认的wiki index文件 * `<Leader>ww` -- 打开默认的 wiki 目录文件
* `<Leader>wt` -- 通过tab实现上一个功能 * `<Leader>wt` -- 在新标签(Tab)中打开 wiki 目录文件
* `<Leader>ws` -- 选择并打开index文件 * `<Leader>ws` -- 在多个 wiki 中选择并打开该 wiki 的目录文件
* `<Leader>wd` -- 删除进入的wiki文件 * `<Leader>wd` -- 删除当前 wiki 文件
* `<Leader>wr` -- 重命名你进入的wiki文件 * `<Leader>wr` -- 重命名当前 wiki 文件
* `<Enter>` -- 进入/创建 wiki 链接 * `<Enter>` -- 创建或打开 wiki 链接
* `<Shift-Enter>` -- 通过分屏模式sp,进入/创建wiki链接 * `<Shift-Enter>` -- 先上下分屏再打开 wiki 链接(若非链接则先创建)
* `<Ctrl-Enter>` -- 通过分屏模式vs,进入/创建wiki链接 * `<Ctrl-Enter>` -- 先左右分屏再打开 wiki 链接(若非链接则先创建)
* `<Backspace>` -- 返回父节点 * `<Backspace>` -- 返回之前浏览的 wiki 文件
* `<Tab>` -- 寻找下一个wiki链接 * `<Tab>` -- 跳到本文件中下一个 wiki 链接
* `<Shift-Tab>` -- 寻找上一个wiki链接 * `<Shift-Tab>` -- 跳到本文件中上一个 wiki 链接
查看`:h vimwiki-mappings` 更多快捷键说明,请阅 `:h vimwiki-mappings`
命令 命令
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
* `:Vimwiki2HTML` -- 转换当前wiki成为html * `:Vimwiki2HTML` -- 当前 wiki 文件转换成 HTML 网页
* `:VimwikiAll2HTML` -- 转化你的全部wiki到html * `:VimwikiAll2HTML` -- 把所有 wiki 文件转换成 HTML 网页
* `:help vimwiki-commands` -- 显示全部命令 * `:help vimwiki-commands` -- 显示全部命令
安装细节 安装
============================================================================== ==============================================================================
在安装之前,你需要做的 准备工作
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
定在`vimrc`中,你的设置是这样的。 保在 `vimrc` 中加入了以下设置:
set nocompatible set nocompatible
filetype plugin on filetype plugin on
syntax on syntax on
如果没有他们Vimwiki将无法正常工作。 没有这些设置Vimwiki 将无法正常工作。
通过 [Vim packages](http://vimhelp.appspot.com/repeat.txt.html#packages) 安装(Vim 7.4.1528 后)
------------------------------------------------------------------------------
git clone https://github.com/vimwiki/vimwiki.git ~/.vim/pack/plugins/start/vimwiki
使用 pathogen (译者注:一个插件) (http://www.vim.org/scripts/script.php?script_id=2332 ) 通过 [Pathogen](http://www.vim.org/scripts/script.php?script_id=2332) 安装
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
cd ~/.vim cd ~/.vim
@@ -128,4 +130,32 @@ normal 模式:
cd bundle cd bundle
git clone https://github.com/vimwiki/vimwiki.git git clone https://github.com/vimwiki/vimwiki.git
然后启动vim,使用`:Helptags` 然后 `:help vimwiki`来确保他已经被安装了。 通过 [Vim-Plug](https://github.com/junegunn/vim-plug) 安装
------------------------------------------------------------------------------
`vimrc` 中加入以下插件设置:
Plug 'vimwiki/vimwiki'
然后运行 `:PlugInstall`
通过 [Vundle](https://github.com/VundleVim/Vundle.vim) 安装
------------------------------------------------------------------------------
`vimrc` 中加入 `Plugin 'vimwiki/vimwiki'`,然后执行:
vim +PluginInstall +qall
或者下载 [zip 压缩包](https://github.com/vimwiki/vimwiki/archive/master.zip)然后解压到 `~/.vim/bundle/` 目录下。
安装后,启动 Vim 并执行 `:Helptags` 以及 `:help vimwiki`,检查安装是否成功。
获取帮助
==============================================================================
遇到问题?在 Freenode 的 IRC 频道 `#vimwiki`[网页聊天](https://webchat.freenode.net/?channels=#vimwiki))提问,或者发送问题到[邮件列表](https://groups.google.com/forum/#!forum/vimwiki)上吧。
----
\* 前面截图中用的是 [solarized 配色方案](https://github.com/altercation/vim-colors-solarized)以及 [lightline](https://github.com/itchyny/lightline.vim) 插件。
+156 -87
View File
@@ -1,51 +1,144 @@
A Personal Wiki For Vim # VimWiki: A Personal Wiki For Vim
==============================================================================
![screenshot1](doc/screenshot_1.png) [中文](README-cn.md)
![screenshot2](doc/screenshot_2.png) *
Intro - [Intro](#intro)
------------------------------------------------------------------------------ - [Installation](#installation)
- [Prerequisites](#prerequisites)
- [VIM Packages](#installation-using-vim-packages-since-vim-741528)
- [Pathogen](#installation-using-pathogen)
- [Vim-Plug](#installation-using-vim-plug)
- [Vundle](#installation-using-vundle)
- [Basic Markup](#basic-markup)
- [Lists](#lists)
- [Key Bindings](#key-bindings)
- [Commands](#commands)
- [Changing Wiki Syntax](#changing-wiki-syntax)
- [Getting Help](#getting-help)
- [Helping VimWiki](#helping-vimwiki)
- [Wiki](https://github.com/vimwiki/vimwiki/wiki)
- [License](#license)
Vimwiki is a personal wiki for Vim -- a number of linked text files that have ## Intro
VimWiki is a personal wiki for Vim -- a number of linked text files that have
their own syntax highlighting. their own syntax highlighting.
With Vimwiki you can: With VimWiki you can:
* organize notes and ideas * Organize notes and ideas
* manage todo-lists * Manage to-do lists
* write documentation * Write documentation
* maintain a diary * Maintain a diary
* export everything to HTML * Export everything to HTML
To do a quick start press `<Leader>ww` (this is usually `\ww`) to go to your index To do a quick start press `<Leader>ww` (this is usually `\ww`) to go to your
wiki file. By default it is located in `~/vimwiki/index.wiki`. index wiki file. By default it is located in `~/vimwiki/index.wiki`.
Feed it with the following example: Feed it with the following example:
```
= My knowledge base = = My knowledge base =
* Tasks -- things to be done _yesterday_!!! * Tasks -- things to be done _yesterday_!!!
* Project Gutenberg -- good books are power. * Project Gutenberg -- good books are power.
* Scratchpad -- various temporary stuff. * Scratchpad -- various temporary stuff.
```
Place your cursor on `Tasks` and press Enter to create a link. Once pressed, Place your cursor on `Tasks` and press Enter to create a link. Once pressed,
`Tasks` will become `[[Tasks]]` -- a Vimwiki link. Press Enter again to `Tasks` will become `[[Tasks]]` -- a VimWiki link. Press Enter again to
open it. Edit the file, save it, and then press Backspace to jump back to your open it. Edit the file, save it, and then press Backspace to jump back to your
index. index.
A Vimwiki link can be constructed from more than one word. Just visually A VimWiki link can be constructed from more than one word. Just visually
select the words to be linked and press Enter. Try it with `Project Gutenberg`. select the words to be linked and press Enter. Try it with `Project Gutenberg`.
The result should look something like: The result should look something like:
```
= My knowledge base = = My knowledge base =
* [[Tasks]] -- things to be done _yesterday_!!! * [[Tasks]] -- things to be done _yesterday_!!!
* [[Project Gutenberg]] -- good books are power. * [[Project Gutenberg]] -- good books are power.
* Scratchpad -- various temporary stuff. * Scratchpad -- various temporary stuff.
```
Basic Markup ## Screenshots
------------------------------------------------------------------------------
![Lists View](doc/lists.png)
![Entries View](doc/entries.png)
![Todos View](doc/todos.png)
![Wiki View](doc/wiki.png)
## Installation
### Prerequisites
Make sure you have these settings in your vimrc file:
```vim
set nocompatible
filetype plugin on
syntax on
```
Without them VimWiki will not work properly.
#### Installation using [Vim packages](http://vimhelp.appspot.com/repeat.txt.html#packages) (since Vim 7.4.1528)
```sh
git clone https://github.com/vimwiki/vimwiki.git ~/.vim/pack/plugins/start/vimwiki
```
#### Installation using [Pathogen](http://www.vim.org/scripts/script.php?script_id=2332)
```sh
cd ~/.vim
mkdir bundle
cd bundle
git clone https://github.com/vimwiki/vimwiki.git
```
#### Installation using [Vim-Plug](https://github.com/junegunn/vim-plug)
Add the following to the plugin-configuration in your vimrc:
```vim
Plug 'vimwiki/vimwiki'
```
Then run `:PlugInstall`.
#### Installation using [Vundle](https://github.com/VundleVim/Vundle.vim)
Add `Plugin 'vimwiki/vimwiki'` to your vimrc file and run
```sh
vim +PluginInstall +qall
```
Or download the [zip
archive](https://github.com/vimwiki/vimwiki/archive/master.zip) and extract it
in `~/.vim/bundle/`
Then launch Vim, run `:Helptags` and then `:help vimwiki` to verify it was
installed.
## Basic Markup
```
= Header1 = = Header1 =
== Header2 == == Header2 ==
=== Header3 === === Header3 ===
@@ -56,10 +149,11 @@ Basic Markup
[[wiki link]] -- wiki link [[wiki link]] -- wiki link
[[wiki link|description]] -- wiki link with description [[wiki link|description]] -- wiki link with description
```
### Lists:
Lists: ```
* bullet list item 1 * bullet list item 1
- bullet list item 2 - bullet list item 2
- bullet list item 3 - bullet list item 3
@@ -74,15 +168,13 @@ Lists:
2. numbered list item 2 2. numbered list item 2
a) numbered list item 3 a) numbered list item 3
b) numbered list item 4 b) numbered list item 4
```
For other syntax elements, see `:h vimwiki-syntax` For other syntax elements, see `:h vimwiki-syntax`
## Key bindings
Key bindings Normal mode:
------------------------------------------------------------------------------
normal mode:
* `<Leader>ww` -- Open default wiki index file. * `<Leader>ww` -- Open default wiki index file.
* `<Leader>wt` -- Open default wiki index file in a new tab. * `<Leader>wt` -- Open default wiki index file in a new tab.
@@ -98,84 +190,61 @@ normal mode:
For more keys, see `:h vimwiki-mappings` For more keys, see `:h vimwiki-mappings`
## Commands
Commands * `:VimWiki2HTML` -- Convert current wiki link to HTML
------------------------------------------------------------------------------ * `:VimWikiAll2HTML` -- Convert all your wiki links to HTML
* `:Vimwiki2HTML` -- Convert current wiki link to HTML
* `:VimwikiAll2HTML` -- Convert all your wiki links to HTML
* `:help vimwiki-commands` -- list all commands * `:help vimwiki-commands` -- list all commands
* `:help vimwiki` -- General vimwiki help docs * `:help vimwiki` -- General vimwiki help docs
## Changing Wiki Syntax
Changing Wiki Syntax VimWiki currently ships with 3 syntaxes: VimWiki (default), Markdown
------------------------------------------------------------------------------ (markdown), and MediaWiki (media)
Vimwiki currently ships with 3 syntaxes: Vimwiki (default), Markdown (markdown), and MediaWiki (media) If you would prefer to use either Markdown or MediaWiki syntaxes, set the
following option in your .vimrc:
```vim
If you would prefer to use either Markdown or MediaWiki syntaxes, set the following option in your .vimrc:
```
let g:vimwiki_list = [{'path': '~/vimwiki/', let g:vimwiki_list = [{'path': '~/vimwiki/',
\ 'syntax': 'markdown', 'ext': '.md'}] \ 'syntax': 'markdown', 'ext': '.md'}]
``` ```
## Getting help
Installation **Have a question?**
============================================================================== Visit the IRC channel [`#vimwiki`](https://webchat.freenode.net/?channels=#vimwiki) on Freenode ([webchat](https://webchat.freenode.net/?channels=#vimwiki), also synced to Matrix/Riot: `#freenode_#vimwiki:matrix.org`) or post to the [mailing list](https://groups.google.com/forum/#!forum/vimwiki).
Prerequisites ## Helping VimWiki
------------------------------------------------------------------------------
Make sure you have these settings in your vimrc file: VimWiki has a lot of users but only very few recurring developers or people
helping the community. Your help is therefore appreciated. Everyone can help!
See [#625](https://github.com/vimwiki/vimwiki/issues/625) for information on
how you can help.
set nocompatible ## License
filetype plugin on
syntax on
Without them Vimwiki will not work properly. MIT License
Copyright (c) 2008-2010 Maxim Kim
2013-2017 Daniel Schemala
Installation using [Vim packages](http://vimhelp.appspot.com/repeat.txt.html#packages) (since Vim 7.4.1528) Permission is hereby granted, free of charge, to any person obtaining a copy
------------------------------------------------------------------------------ of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
git clone https://github.com/vimwiki/vimwiki.git ~/.vim/pack/plugins/start/vimwiki The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
Installation using [Pathogen](http://www.vim.org/scripts/script.php?script_id=2332) THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
------------------------------------------------------------------------------ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
cd ~/.vim AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
mkdir bundle LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
cd bundle OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
git clone https://github.com/vimwiki/vimwiki.git SOFTWARE.
Installation using [Vim-Plug](https://github.com/junegunn/vim-plug)
------------------------------------------------------------------------------
Add the following to the plugin-configuration in your vimrc:
Plug 'vimwiki/vimwiki', { 'branch': 'dev' }
Then run `:PlugInstall`.
Installation using [Vundle](https://github.com/VundleVim/Vundle.vim)
------------------------------------------------------------------------------
Add `Plugin 'vimwiki/vimwiki'` to your vimrc file and run
vim +PluginInstall +qall
Or download the [zip archive](https://github.com/vimwiki/vimwiki/archive/master.zip) and extract it in `~/.vim/bundle/`
Then launch Vim, run `:Helptags` and then `:help vimwiki` to verify it was installed.
Getting help
==============================================================================
Have a question? Visit the IRC channel `#vimwiki` on Freenode ([webchat](https://webchat.freenode.net/?channels=#vimwiki))
or post to the [mailing list](https://groups.google.com/forum/#!forum/vimwiki).
----
\* Screenshots made with the [solarized colorscheme](https://github.com/altercation/vim-colors-solarized)
and [lightline](https://github.com/itchyny/lightline.vim)
+7 -1
View File
@@ -152,7 +152,13 @@ function! vimwiki#base#resolve_link(link_text, ...)
let link_infos.anchor = join(split_lnk[1:], '#') let link_infos.anchor = join(split_lnk[1:], '#')
endif endif
if link_text == '' " because the link was of the form '#anchor' if link_text == '' " because the link was of the form '#anchor'
let link_text = fnamemodify(source_file, ':p:t:r') let expected_ext = vimwiki#u#escape(vimwiki#vars#get_wikilocal('ext')).'$'
if source_file =~# expected_ext
" Source file has expected extension. Remove it, it will be added later on
let ext_len = strlen(vimwiki#vars#get_wikilocal('ext'))
let link_text = fnamemodify(source_file, ':p:t')[:-ext_len-1]
endif
endif endif
endif endif
+4 -2
View File
@@ -1072,7 +1072,9 @@ function! s:process_tag_h(line, id)
let h_text = num.' '.h_text let h_text = num.' '.h_text
endif endif
let h_complete_id = s:escape_html_attribute(h_complete_id) let h_complete_id = s:escape_html_attribute(h_complete_id)
let h_part = '<div id="'.h_complete_id.'"><h'.h_level.' id="'.h_id.'"' let h_part = '<div id="'.h_complete_id.'">'
let h_part .= '<h'.h_level.' id="'.h_id.'" class="header">'
let h_part .= '<a href="#'.h_complete_id.'"'
else else
@@ -1088,7 +1090,7 @@ function! s:process_tag_h(line, id)
let h_text = s:process_inline_tags(h_text, a:id) let h_text = s:process_inline_tags(h_text, a:id)
let line = h_part.h_text.'</h'.h_level.'></div>' let line = h_part.h_text.'</a></h'.h_level.'></div>'
let processed = 1 let processed = 1
endif endif
+1
View File
@@ -25,6 +25,7 @@ del {text-decoration: line-through; color: #777777;}
.justcenter {text-align: center;} .justcenter {text-align: center;}
.center {margin-left: auto; margin-right: auto;} .center {margin-left: auto; margin-right: auto;}
.tag {background-color: #eeeeee; font-family: monospace; padding: 2px;} .tag {background-color: #eeeeee; font-family: monospace; padding: 2px;}
.header a {text-decoration: none; color: inherit;}
/* classes for items of todo lists */ /* classes for items of todo lists */
.rejected { .rejected {
+2 -2
View File
@@ -85,8 +85,8 @@ function! s:populate_global_variables()
" this regexp defines what can form a link when the user presses <CR> in the " this regexp defines what can form a link when the user presses <CR> in the
" buffer (and not on a link) to create a link " buffer (and not on a link) to create a link
" basically, it's Ascii alphanumeric characters plus #|./@-_~ plus all " basically, it's Ascii alphanumeric characters plus #|./@-_~ plus all
" non-Ascii characters " non-Ascii characters, except that . is not accepted as the last character
let g:vimwiki_global_vars.rxWord = '[^[:blank:]!"$%&''()*+,:;<=>?\[\]\\^`{}]\+' let g:vimwiki_global_vars.rxWord = '[^[:blank:]!"$%&''()*+,:;<=>?\[\]\\^`{}]*[^[:blank:]!"$%&''()*+.,:;<=>?\[\]\\^`{}]'
let g:vimwiki_global_vars.rx_wikilink_prefix1 = g:vimwiki_global_vars.rx_wikilink_prefix . let g:vimwiki_global_vars.rx_wikilink_prefix1 = g:vimwiki_global_vars.rx_wikilink_prefix .
\ g:vimwiki_global_vars.rxWikiLinkUrl . g:vimwiki_global_vars.rx_wikilink_separator \ g:vimwiki_global_vars.rxWikiLinkUrl . g:vimwiki_global_vars.rx_wikilink_separator
BIN
View File
Binary file not shown.

After

Width:  |  Height:  |  Size: 177 KiB

BIN
View File
Binary file not shown.

After

Width:  |  Height:  |  Size: 276 KiB

BIN
View File
Binary file not shown.

After

Width:  |  Height:  |  Size: 249 KiB

+40 -10
View File
@@ -9,7 +9,7 @@
|___| |___| |_| |_||__| |__||___| |___| |_||___| ~ |___| |___| |_| |_||__| |__||___| |___| |_||___| ~
Version: 2.4 Version: 2.4.1
============================================================================== ==============================================================================
CONTENTS *vimwiki* CONTENTS *vimwiki*
@@ -707,7 +707,7 @@ Vimwiki file.
*:VimwikiGoto* *:VimwikiGoto*
Goto link provided by an argument. For example: > Goto link provided by an argument. For example: >
:VimwikiGoto HelloWorld :VimwikiGoto HelloWorld
< opens opens/creates HelloWorld wiki page. < opens/creates HelloWorld wiki page.
Supports |cmdline-completion| for link name. Supports |cmdline-completion| for link name.
@@ -1423,7 +1423,7 @@ Hit |zr| one more time :
Note: If you use the default Vimwiki syntax, folding on list items will work Note: If you use the default Vimwiki syntax, folding on list items will work
properly only if all of them are indented using the current 'shiftwidth'. properly only if all of them are indented using the current 'shiftwidth'.
For MediaWiki syntax, * or # should be in the first column. For Markdown and MediaWiki syntax, * or # should be in the first column.
To turn folding on/off check |g:vimwiki_folding|. To turn folding on/off check |g:vimwiki_folding|.
@@ -2280,8 +2280,8 @@ local mappings |vimwiki_glstar|, |vimwiki_gl#| |vimwiki_gl-|, |vimwiki_gl-|,
|vimwiki_gl1|, |vimwiki_gla|, |vimwiki_glA|, |vimwiki_gli|, |vimwiki_glI| and |vimwiki_gl1|, |vimwiki_gla|, |vimwiki_glA|, |vimwiki_gli|, |vimwiki_glI| and
|vimwiki_i_<C-L>_<C-M>|. |vimwiki_i_<C-L>_<C-M>|.
Note: if you use MediaWiki syntax, you probably would like to set this option Note: if you use Markdown or MediaWiki syntax, you probably would like to set
to 0, because every indented line is considered verbatim text. this option to 0, because every indented line is considered verbatim text.
*vimwiki-option-auto_tags* *vimwiki-option-auto_tags*
@@ -2338,11 +2338,13 @@ Highlight checked list items with a special color:
Value Description~ Value Description~
0 Don't highlight anything. 0 Don't highlight anything.
1 Highlight checked [X] list item with |group-name| "Comment". 1 Highlight only the first line of a checked [X] list item.
2 Highlight checked [X] list item and all its child items. 2 Highlight a complete checked list item and all its child items.
Default: 0 Default: 0
The |group-name| "Comment" is used for highlighting.
Note: Option 2 does not work perfectly. Specifically, it might break if the Note: Option 2 does not work perfectly. Specifically, it might break if the
list item contains preformatted text or if you mix tabs and spaces for list item contains preformatted text or if you mix tabs and spaces for
indenting. Also, indented headers can be highlighted erroneously. indenting. Also, indented headers can be highlighted erroneously.
@@ -2957,7 +2959,7 @@ Contributors and their Github usernames in roughly chronological order:
- Daniel Trnka (@trnila) - Daniel Trnka (@trnila)
- Yuchen Pei (@ycpei) - Yuchen Pei (@ycpei)
- @maqiv - @maqiv
- @dpc - Dawid Ciężarkiewicz (@dpc)
- Drew Hays (@Dru89) - Drew Hays (@Dru89)
- Daniel Etrata (@danetrata) - Daniel Etrata (@danetrata)
- Keith Haber (@kjhaber) - Keith Haber (@kjhaber)
@@ -2971,6 +2973,22 @@ Contributors and their Github usernames in roughly chronological order:
- Zhuang Ma (@mzlogin) - Zhuang Ma (@mzlogin)
- Huy Le (@huynle) - Huy Le (@huynle)
- Nick Borden (@hcwndbyw) - Nick Borden (@hcwndbyw)
- John Campbell (@johnmarcampbell)
- Petrus (@PetrusZ)
- Steven Stallion (@sstallion)
- Daniel Quomsieh (@DQuomsieh)
- Fredrik Arnerup (@farnerup)
- CUI Hao (@cuihaoleo)
- Benjamin Brandtner (@BenjaminBrandtner)
- @sreejith994
- Raphael Feng (@raphaelfeng)
- Kasper Socha (@fte10kso)
- Nicolas Brailovsky (@nicolasbrailo)
- @BenMcH
- Stefan Huber (@shuber2)
- Hugo Hörnquist (@HugoNikanor)
- Rane Brown (@ranebrown)
- @monkinco
============================================================================== ==============================================================================
@@ -2983,7 +3001,13 @@ http://code.google.com/p/vimwiki/issues/list. They may be accessible from
https://github.com/vimwiki-backup/vimwiki/issues. https://github.com/vimwiki-backup/vimwiki/issues.
2.4 (not yet released)~ 2.4.1 (2019-02-20)~
Fixed:
* Fix VimwikiShowVersion function.
* strikethrough `~` characters were not hidden within tables
* Update and format README.md and update screen shots
2.4 (2019-03-24)~
New:~ New:~
* Add the option |g:vimwiki_text_ignore_newline|. * Add the option |g:vimwiki_text_ignore_newline|.
@@ -3003,6 +3027,8 @@ New:~
* Add the %date placeholder, see |vimwiki-date|. * Add the %date placeholder, see |vimwiki-date|.
* Add the option |vimwiki-option-custom_wiki2html_args|. * Add the option |vimwiki-option-custom_wiki2html_args|.
* Add support for HTML-style comments when using markdown syntax. * Add support for HTML-style comments when using markdown syntax.
* Made headings link to themselves in HTML output.
* Add |:VimwikiShowVersion| to check the version
Removed:~ Removed:~
* Remove the undocumented and buggy command :VimwikiReadLocalOptions * Remove the undocumented and buggy command :VimwikiReadLocalOptions
@@ -3027,6 +3053,10 @@ Fixed:~
* Opening the diary and wikis from the menu works correctly now. * Opening the diary and wikis from the menu works correctly now.
* Issue #497: Make |:VimwikiMakeDiaryNote| work outside a wiki buffer. * Issue #497: Make |:VimwikiMakeDiaryNote| work outside a wiki buffer.
* Use markdown syntax in the diary when appropriate. * Use markdown syntax in the diary when appropriate.
* Improve handling of errors on opening files.
* Update links when renaming a page with |:VimwikiRenameLink|.
* Fix losing the highlighting in various situations.
* Improved link normalisation.
* Various other minor fixes. * Various other minor fixes.
@@ -3249,7 +3279,7 @@ http://code.google.com/p/vimwiki/issues/list
* Issue 210: HTML: para enclose header. * Issue 210: HTML: para enclose header.
* Issue 214: External links containing Chinese characters get trimmed. * Issue 214: External links containing Chinese characters get trimmed.
* Issue 218: Command to generate HTML file and open it in webbrowser. See * Issue 218: Command to generate HTML file and open it in webbrowser. See
|:Vimwiki2HTMLBrowse|(bind to <leader>whh) |:Vimwiki2HTMLBrowse|(bind to <Leader>whh)
* NEW: Added <Leader>wh mapping to call |:Vimwiki2HTML| * NEW: Added <Leader>wh mapping to call |:Vimwiki2HTML|
BIN
View File
Binary file not shown.

After

Width:  |  Height:  |  Size: 305 KiB

+24
View File
@@ -9,6 +9,11 @@ if exists("g:loaded_vimwiki") || &cp
endif endif
let g:loaded_vimwiki = 1 let g:loaded_vimwiki = 1
" Set to version number for release, otherwise -1 for dev-branch
let s:plugin_vers = "2.4.1"
" Get the directory the script is installed in
let s:plugin_dir = expand('<sfile>:p:h:h')
let s:old_cpo = &cpo let s:old_cpo = &cpo
set cpo&vim set cpo&vim
@@ -188,6 +193,23 @@ function! s:set_windowlocal_options()
endfunction endfunction
function! s:get_version()
if s:plugin_vers != -1
echo "Stable version: " . string(s:plugin_vers)
else
let l:plugin_rev = system("git --git-dir " . s:plugin_dir . "/.git rev-parse --short HEAD")
let l:plugin_branch = system("git --git-dir " . s:plugin_dir . "/.git rev-parse --abbrev-ref HEAD")
let l:plugin_date = system("git --git-dir " . s:plugin_dir . "/.git show -s --format=%ci")
if v:shell_error == 0
echo "Branch: " . l:plugin_branch
echo "Revision: " . l:plugin_rev
echo "Date: " . l:plugin_date
else
echo "Unknown version"
endif
endif
endfunction
" Initialization of Vimwiki starts here. Make sure everything below does not " Initialization of Vimwiki starts here. Make sure everything below does not
@@ -281,6 +303,8 @@ command! -count=1 VimwikiMakeTomorrowDiaryNote
command! VimwikiDiaryGenerateLinks command! VimwikiDiaryGenerateLinks
\ call vimwiki#diary#generate_diary_section() \ call vimwiki#diary#generate_diary_section()
command! VimwikiShowVersion call s:get_version()
let s:map_prefix = vimwiki#vars#get_global('map_prefix') let s:map_prefix = vimwiki#vars#get_global('map_prefix')
+1 -1
View File
@@ -297,7 +297,7 @@ execute 'syntax match VimwikiItalicBoldT /'.vimwiki#vars#get_syntaxlocal('rxItal
execute 'syntax match VimwikiDelText /'.vimwiki#vars#get_syntaxlocal('rxDelText'). execute 'syntax match VimwikiDelText /'.vimwiki#vars#get_syntaxlocal('rxDelText').
\ '/ contains=VimwikiDelTextChar,@Spell' \ '/ contains=VimwikiDelTextChar,@Spell'
execute 'syntax match VimwikiDelTextT /'.vimwiki#vars#get_syntaxlocal('rxDelText'). execute 'syntax match VimwikiDelTextT /'.vimwiki#vars#get_syntaxlocal('rxDelText').
\ '/ contained contains=VimwikiDelTextChar,@Spell' \ '/ contained contains=VimwikiDelTextCharT,@Spell'
execute 'syntax match VimwikiSuperScript /'.vimwiki#vars#get_syntaxlocal('rxSuperScript'). execute 'syntax match VimwikiSuperScript /'.vimwiki#vars#get_syntaxlocal('rxSuperScript').
\ '/ contains=VimwikiSuperScriptChar,@Spell' \ '/ contains=VimwikiSuperScriptChar,@Spell'