wiki.vim

Ⅰ. 插件描述

A wiki plugin for Vim

Ⅱ. 基本信息

创建日期：  2016-05-27
使用用户：  3
Github星：  119
插件作者：  Karl Yngve Lervåg

Ⅲ. 安装方法

使用Vundle管理器安装

在你的.vimrc下添加: 
Plugin 'lervag/wiki-vim-are-made-of'
… 然后在Vim中运行以下命令: 
:source %
:PluginInstall

对于Vundle版本 < 0.10.2，请用上面的Bundle替换Plugin。

使用NeoBundle管理器安装

在你的.vimrc下添加: 
NeoBundle 'lervag/wiki-vim-are-made-of'
… 然后在Vim中运行以下命令: 
:source %
:NeoBundleInstall

使用VimPlug管理器安装

在你的.vimrc下添加: 
Plug 'lervag/wiki-vim-are-made-of'
… 然后在Vim中运行以下命令: 
:source %
:PlugInstall

使用Pathogen管理器安装

在终端中运行以下命令: 
cd ~/.vim/bundle
git clone https://github.com/lervag/wiki.vim

Ⅳ. 文档说明

# Introduction

This is a Vim plugin for writing and maintaining
a personal wiki. The plugin was initially based on
vimwiki, but it is written mostly from
scratch and is based on a more "do one thing and do it well" philosophy.

Note: wiki.vim is not a filetype plugin. It is designed so that it may be used

  along with filetype plugins, e.g. for dedicated Markdown plugins. One may
  also use [wiki-ft.vim](https://github.com/lervag/wiki-ft.vim) for simple
  syntax highlighting and folding of `.wiki` files, if desired.

This README file contains basic information on how to get started, as well as
a list of available features. For more details, please confer the
full documentation.

Table of contents

Quick Start

Installation

If you use vim-plug, then add the
following line to your vimrc file:

Plug 'lervag/wiki.vim'

Or use some other plugin manager:

Usage

This outlines the basic steps to get started:

  1. Create a wiki directory where the wiki files should be stored, for instance
    ~/documents/wiki.

  2. Add the following to your vimrc file:

    let g:wiki_root = '~/documents/wiki'
  3. Now you can open the index file (by default index.wiki) with <leader>ww
    and start to add your notes as desired.

Features

  • Wiki functionality

    • Global mappings for accessing a specified wiki

    • Local mappings for

      • Navigation (follow links, go back, etc)
      • Renaming pages (will also update links in other pages)
      • Creating a table of contents
      • Toggling links
      • Viewing wiki link graphs
    • Completion of wiki links and link anchors

    • Text objects

      • iu au Link url
      • it at Link text

  • Support for journal entries

    • Navigating the journal back and forth with <c-j> and <c-k>

    • Support for parsing journal entries in order to make weekly and monthly

      1. The parsed result needs manual editing for good results.

  • Utility functionality

    • Toggling lists (marking as done/undone or add/remove TODO)
    • Running code snippets (Note: This needs work)

    • Text objects

      • il al List items

  • Third-party support

    • CtrlP: CtrlPWiki command
    • unite
    • denite
    • ncm2: SubscopeDetector for nested completion
    • fzf: WikiFzfPages and WikiFzfToc commands

TODO

This is a list of TODO items that anyone may follow up on. I am very willing to
accept contributions, both as issues describing problems or
as pull requests for implementing bug fixes or missing features.

  • [ ] Allow to choose the default type of link

  • [ ] vimwiki like TODO list toggles

      (cf. [#1](../../issues/1))
  • [x] Allow journal entries per week/months (cf. #2)
  • [ ] Improve the "execute code section" feature

Related projects

Acknowledgements

Without vimwiki, thus plugin would never
have existed. So my thanks go to the smart people that developed and maintains
vimwiki, both for the inspiration and for the ideas.

添加新评论