vimwiki使用技巧

vimwiki强大的功能即是markdown语法的使用和强大的html输出,所以,若是可以很好的使用这个插件,写一些可以在网页上显示的内容,如博客等很是强大(github上建博客对于技术人员来讲很流行),那么,咱们就开始把。php

基本vim语法以下:css

= 一级标题 =  
== 二级标题 ==
=== 三级标题 ===
这次类推。

当标题前面有空白时,标题文本居中对齐。
       = 我是居中的标题 =

*粗体*  _斜体_  ~~删除线~~   `Some Code 代码` 

注意 这几个针对文本格式的标签,都要求左右留有空白。
请注意你的代码高亮,通常来讲,有了相应的高亮,你用的wiki标签才生效。

^上^标  ,,下,,标

    四个空格缩进的内容会被转成blockquote
    
{{{ class="brush:php"
这中间的内容会被放到一个 pre 里,适合贴代码。
上面的 class 是可选的,通常用来安排代码高亮。
事实上,这一块代码展现就是放在了一个 pre 里。
}}}

WikiItem  大写开头的驼峰英文会被自动看成一个维基词条,并添加连接
[[Wiki Item]]  这是手动创建维基词条的方式
[[wiki item|description]]  输出HTML时显示description,链到 wiki item
http://ktmud.com/  外部URL会被自动转换成连接
[http://ktmud.com Ktmud]  带文字的外链
[images/hello.jpg] 输出 <img src="images/hello.jpg" />
[[images/hello.jpg]] 输出图片,并链向图片地址

* 无序列表 条目一
* 无序列表 条目二 
  - 子列表 条目一
  - 自列表 条目二

# 有序列表 条目一
# 有序列表 条目二

* 和 - 是等价的,后面必须跟一个空格

特殊占位符:html

在wiki条目中使用如下占位符,能对生成的HTML文件作一些特殊的处理。
    %toc 自动生成的目录
    %title 指定HTML文档的title,建议放到文档最末尾。若是不指定,title 就是文件名
    %nohtml 告诉 vimwiki 不为某条目生成HTML文件。即便你在该条目打开时为它单独执行 :Vimwiki2HTML ,也不会生成

键操做:java

快捷键总览
    <leader>ww 在当前窗口打开维基首页
    <leader>wt 在新tab打开维基首页
    <leader>w<leader>w 打开/新建当天日记
    <leader>w<keader>t 在新tab打开/新建当天日记
    <leader>ws 选择维基项目(详见下面的“多个维基项目”一节)

还没有创建的词条会被显示为红色(或其余你的 Vim 语法高亮定义的错误颜色),在词条上敲回车键,能够编辑这个词条。点击 Shift-回车,在新的分割窗口编辑该词条。编辑好之后点击退格(Backspace)键,能够返回链入页
    使用 Tab 键,能够跳到下一个维基词条或连接,使用 Shift-Tab 跳到上一个
    插入模式下使用Shift-Enter,插入 <br> 并换行
    在标题上点击 - 和 = (也就是 - 和 + ),能够分表提高和下降标题层级

另有条目管理相关的快捷键 <leader>wd<leader>wr ,分表表明删除和重命名当前条目。其中重命名条目很强大,还能更改全部其余条目内引用了该条目的连接。 重命名以后别忘了从新生成全部条目的HTML。
git

更改一点默认配置github

转自:http://wiki.ktmud.com/tips/vim/vimwiki-guide.htmlvim

" vimwiki
 
"     是否在词条文件保存时就输出html  这个会让保存大词条比较慢
      因此我默认没有启用  有须要的话就把这一行复制到下面去
"     \ 'auto_export': 1,
 
" 多个维基项目的配置
let g:vimwiki_list = [{'path': 'E:/My Dropbox/vimwiki/',
      \ 'html_header': 'E:/My Dropbox/Public/vimwiki_template/header.htm',
      \ 'html_footer': 'E:/My Dropbox/Public/vimwiki_template/footer.htm',
      \ 'diary_link_count': 5},
      \{'path': 'Z:\demo\qiuchi\wiki'}]
 
" 对中文用户来讲,咱们并不怎么须要驼峰英文成为维基词条
let g:vimwiki_camel_case = 0
 
" 标记为完成的 checklist 项目会有特别的颜色
let g:vimwiki_hl_cb_checked = 1
 
" 个人 vim 是没有菜单的,加一个 vimwiki 菜单项也没有意义
let g:vimwiki_menu = ''
 
" 是否开启按语法折叠  会让文件比较慢
"let g:vimwiki_folding = 1
 
" 是否在计算字串长度时用特别考虑中文字符
let g:vimwiki_CJK_length = 1
 
" 详见下文...
let g:vimwiki_valid_html_tags='b,i,s,u,sub,sup,kbd,del,br,hr,div,code,h1'

作一个你本身的模板

vimwiki 生成的HTML会都会连接相应vimwiki_html目录下的style.css。若是你不本身指定,它会自动生成一个默认的。CSS禅意花园的境界是 什么来着,仅仅修改 style.css 就能拥有风格彻底不一样的页面。经过简单修改 style.css ,你彻底能够创造本身风格的维基站。加上自定义文档头部和尾部的功能,折腾出一个我的网站来绰绰有余。固然,若是你还在想新闻列表,feed订阅什么的, 请赶快走开。毕竟, vimwiki 不是 CMS 。markdown

惋惜的是,并不能指定一个 style.css 的模板,若是你还折腾了一些 JavaScript 加强,就更麻烦了。须要的话请自行把相关文件复制过去吧。固然,你也能够直接把本页面另存为,使用个人模板!具体实现请本身折腾。ide

相关文章
相关标签/搜索