Особенности

• Поддерживаются три синтаксиса разметки: собственный синтаксис Vimwiki, Markdown, MediaWiki
  экспортировать все в HTML
  ссылки на другие вики-страницы и внешние файлы
  поиск по всем вики-страницам
  наметить заметки и задачи в списках с отступами
  быстро манипулировать нумерованными и маркированными списками
  отмечать страницы вики или произвольные места и быстро переходить к тегам
  автоматически отформатированные таблицы

Быстрый старт

Нажмите <Leader>ww (this is usually \ww) чтобы перейти на вашу страницу индекса. По умолчанию он находится в ~/vimwiki/index.wiki.

Накормите его следующим примером:

= My knowledge base =
    * Tasks -- things to be done _yesterday_!!!
    * Project Gutenberg -- good books are power.
    * Scratchpad -- various temporary stuff.

Наведите курсор на задачи и нажмите Enter, чтобы создать ссылку. Нажмите 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.

Смотрите: h vimwiki для полной документации.

Основная разметка (синтаксис по умолчанию)

= Header1 =
== Header2 ==
=== Header3 ===*bold text*
_italic text_[[wiki link]]
[[wiki link|description]]* bullet list item 1
* bullet list item 2
    a) numbered list item 1
    b) numbered list item 2{{{python
def greet(s):
    print("Hello, " + s)
}}}| a table |  |
|---------|--|
|         |  |

Другие синтаксические элементы см .: h vimwiki-syntax

Привязки клавиш

• <Leader>ww – Откройте файл индекса wiki по умолчанию
• <Leader>ws – Выберите и откройте файл индекса вики
• <Enter> – Follow/Create wiki link
• <Backspace> – Вернуться к родительской (предыдущей) вики-ссылке
• <Tab> – Найти следующую вики ссылку
• <Shift-Tab> – Найти предыдущую ссылку вики

Дополнительные ключи см .: h vimwiki-mappings

команды

• :Vimwiki2HTML – Конвертировать текущую вики-страницу в HTML
• :VimwikiAll2HTML – Конвертируйте все ваши вики-страницы в HTML

Для получения дополнительной информации см .: h vimwiki-команды

Монтаж

Используйте менеджер плагинов по вашему выбору для установки vimwiki.

Предпосылки

Убедитесь, что у вас есть эти настройки в вашем файле vimrc:

set nocompatible
filetype plugin on
syntax on

Без них Vimwiki не будет работать должным образом.

Установка с использованием
 Vim-Plug

Добавьте следующее в плагин-конфигурацию в вашем vimrc:

Plug 'vimwiki/vimwiki'

Then run :PlugInstall.

Установка с использованием
 Pathogen

cd ~/.vim
mkdir bundle
cd bundle
git clone https://github.com/vimwiki/vimwiki.git

Или загрузите последнюю версию (zip, tar) и распакуйте ее в
 ~/.vim/bundle/

Затем запустите Vim, запустите: Helptags, а затем: help vimwiki, чтобы убедиться, что он установлен.