vim-yawiki


Ⅰ. 插件描述

Плагин для работы с Яндексовой вики-разметкой.

Ⅱ. 基本信息

创建日期:  2017-02-13
使用用户:  1
Github星:  6
插件作者:  Boris Kuchin

Ⅲ. 安装方法

使用Vundle管理器安装

在你的.vimrc下添加:
Plugin 'elricbk/vim-yawiki'
… 然后在Vim中运行以下命令:
:source %
:PluginInstall

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

使用NeoBundle管理器安装

在你的.vimrc下添加:
NeoBundle 'elricbk/vim-yawiki'
… 然后在Vim中运行以下命令:
:source %
:NeoBundleInstall

使用VimPlug管理器安装

在你的.vimrc下添加:
Plug 'elricbk/vim-yawiki'
… 然后在Vim中运行以下命令:
:source %
:PlugInstall

使用Pathogen管理器安装

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

Ⅳ. 文档说明

# vim-yawiki Build Status

Плагин для работы с Яндексовой вики-разметкой. Поддерживает:

  • Подсветку синтаксиса
  • Folding секций и врезок
  • Переход по заголовкам с помощью ]] и [[
  • Клавиши для форматирования текста

Пример форматирования

Подсветка синтаксиса

Поддерживаются следующие виды разметки:

  • Заголовки
  • Базовое форматирование (полужирный, курсивный, подчёркнутый, моноширинный, мелкий, зачёркнутый текст; вопросы, замечания, текст синего/красного/зелёного/жёлтого/серого цвета)
  • Цитирование текста (однострочное и многострочное)
  • Термины
  • Врезки
  • Вывод HTML/код (без поддержки подсветки внутри)
  • Логины (this@, @that и кто:login)
  • Команды (подсвечиваются целиком, параметры внутри не размечаются)
  • Ссылки (прямо в тексте, в круглых и квадратных скобках)
  • Разметка таблиц
  • Номера тикетов
  • HTML entities

Вложенная разметка не поддерживается (bold italic, например, не работает).
Подсветка в основном задавалась через стандартные группы (String, Comment, etc.), поэтому нормально должна выглядеть на любой цветовой схеме. Там, где нужны были конкретные цвета (например, для разноцветных заметок), они задавались через стандартные цвета цветовой схемы (darkred, green, etc.).

Folding

Fold-ы добавляются для всех секций (уровень fold-а соответствует уровню секции минус один, т.е. для заголовков первого уровня fold не добавляется) и врезок (уровень fold-а равно уровню текущей секции плюс 1).

Автоматически ничего не сворачивается, специальные символы для сворачивания элементов списка не поддерживаются.

Переход по секциям

Добавлены ]] и [[, которые ходят по заголовкам вперёд и назад соответственно. Уровень заголовков при этом не учитывается.

Форматирование

Плагин определяет несколько комбинаций доступных для использования:

<Plug>(yawiki-mark-bold)
<Plug>(yawiki-mark-code)
<Plug>(yawiki-mark-escaped)
<Plug>(yawiki-mark-italic)
<Plug>(yawiki-mark-link)
<Plug>(yawiki-mark-monospaced)
<Plug>(yawiki-mark-note)
<Plug>(yawiki-mark-quote)
<Plug>(yawiki-mark-strikeout)
<Plug>(yawiki-mark-underline)

Каждая комбинация рассчитана на использование в visual-режиме и оборачивает выделенный текст в соответствующее форматирование.

Комбинации клавиш по умолчанию

По умолчанию для форматирования назначаются комбинации клавиш, которые начинаются с <Leader>m (мнемоника mark bold_, _mark italic и т.д.).

vmap <buffer> <Leader>mb <Plug>(yawiki-mark-bold)
vmap <buffer> <Leader>mc <Plug>(yawiki-mark-code)
vmap <buffer> <Leader>me <Plug>(yawiki-mark-escaped)
vmap <buffer> <Leader>mi <Plug>(yawiki-mark-italic)
vmap <buffer> <Leader>ml <Plug>(yawiki-mark-link)
vmap <buffer> <Leader>mm <Plug>(yawiki-mark-monospaced)
vmap <buffer> <Leader>mn <Plug>(yawiki-mark-note)
vmap <buffer> <Leader>mq <Plug>(yawiki-mark-quote)
vmap <buffer> <Leader>ms <Plug>(yawiki-mark-strikeout)
vmap <buffer> <Leader>mu <Plug>(yawiki-mark-underline)

Отключить комбинации клавиш по умолчанию можно с помощью опции g:yawiki_disable_formatting.

Комбинации для кириллицы

Если хочется использовать эти же комбинации клавиш не переключаясь с русского на английский, то можно использовать опцию g:yawiki_cyrillic_prefix. Её нужно установить в ту букву, которая соответствует используемому mapleader в русской раскладке. Например, при использовании в качестве mapleader запятой, можно написать:

let g:yawiki_cyrillic_prefix = 'б'

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

添加新评论