vimwiki
v2024.01.24
中文
Vimwiki - это личный вики для VIM - ряд связанных текстовых файлов, которые имеют свой собственный синтаксис. См. Вимвики Вики для примера веб -сайта, построенного с Vimwiki!
Если вы заинтересованы в соревнованиях, посмотрите на этот раздел.
С Вимвики вы можете:
Чтобы сделать быстрый старт, нажмите <Leader>ww (по умолчанию ww ), чтобы перейти в свой индексный вики -файл. По умолчанию он находится в ~/vimwiki/index.wiki . См :h vimwiki_list для регистрации другого пути/вики.
Поправьте его следующим примером:
= My knowledge base =
* Tasks -- things to be done _yesterday_!!!
* Project Gutenberg -- good books are power.
* Scratchpad -- various temporary stuff.
Поместите курсор на Tasks и нажмите Enter, чтобы создать ссылку. После нажатия Tasks станут [[Tasks]] - вимвики. Нажмите Enter снова, чтобы открыть его. Отредактируйте файл, сохраните его, а затем нажмите Backspace, чтобы вернуться к своему индексу.
Вимвики может быть построена из более чем одного слова. Просто визуально выберите слова, которые должны быть связаны, и нажмите Enter. Попробуйте, с Project Gutenberg . Результат должен выглядеть как -то вроде:
= My knowledge base =
* [[Tasks]] -- things to be done _yesterday_!!!
* [[Project Gutenberg]] -- good books are power.
* Scratchpad -- various temporary stuff.
Vimwiki был протестирован на Vim> = 7,3 . Это может работать на более старых версиях, но не будет официально поддерживать. Известно, что он работает над Neovim, хотя, вероятно, у него есть Neovim-специфические ошибки.
Убедитесь, что у вас есть эти настройки в вашем файле Vimrc:
set nocompatible
filetype plugin on
syntax onБез них Вимвики не будет работать должным образом.
git clone https://github.com/vimwiki/vimwiki.git ~ /.vim/pack/plugins/start/vimwiki
# to generate documentation i.e. ':h vimwiki'
vim -c ' helptags ~/.vim/pack/plugins/start/vimwiki/doc ' -c quit
Примечания:
:h helptags для проблем с установкой документации.:h packages . cd ~ /.vim
mkdir bundle
cd bundle
git clone https://github.com/vimwiki/vimwiki.git
Добавьте следующее в конфигурацию плагина в вашем VIMRC:
Plug ' vimwiki/vimwiki '
Затем запустите :PlugInstall .
Добавьте Plugin 'vimwiki/vimwiki' в свой файл Vimrc и запустите:
vim +PluginInstall +qall
Загрузите архив ZIP и извлеките его в ~/.vim/bundle/
Затем запустите Vim, запустите :Helptags , а затем :help vimwiki , чтобы убедиться, что он был установлен.
= Header1 =
== Header2 ==
=== Header3 ===
*bold* -- bold text
_italic_ -- italic text
[[wiki link]] -- wiki link
[[wiki link|description]] -- wiki link with description
* bullet list item 1
- bullet list item 2
- bullet list item 3
* bullet list item 4
* bullet list item 5
* bullet list item 6
* bullet list item 7
- bullet list item 8
- bullet list item 9
1. numbered list item 1
2. numbered list item 2
a) numbered list item 3
b) numbered list item 4
Для других синтаксических элементов см :h vimwiki-syntax
- [.] Partially completed item with sub-tasks
- [X] Completed sub-task
- [ ] Incomplete sub-task
- [ ] Other incomplete sub-task
- [ ] Incomplete item
ПРИМЕЧАНИЕ. Ваш терминал может помешать захвату некоторых привязков по умолчанию, перечисленных ниже. См :h vimwiki-local-mappings для предложений для альтернативных привязков, если вы столкнетесь с проблемой.
<Leader>ww - Откройте файл индекса вики по умолчанию.<Leader>wt - Откройте файл вики -индекса по умолчанию на новой вкладке.<Leader>ws - выберите и откройте файл индекса вики.<Leader>wd - Удалить вики -файл, в котором вы находитесь.<Leader>wr - переименование вики -файла, в котором вы находитесь.<Enter> - Следуйте/Создайте ссылку на вики.<Shift-Enter> -разделить и следить/создать ссылку на вики.<Ctrl-Enter> -вертикальное разделение и следуйте/создайте вики.<Backspace> - вернуться к родителям (предыдущему) вики.<Tab> - Найдите следующую ссылку на вики.<Shift-Tab> -Найдите предыдущую ссылку на вики. Обратитесь к полной документации по адресу :h vimwiki-mappings чтобы увидеть еще много привязки.
:Vimwiki2HTML - преобразовать текущую ссылку вики в HTML.:VimwikiAll2HTML - преобразовать все свои вики ссылки на HTML.:help vimwiki-commands -Перечислите все команды.:help vimwiki - генерал Вимвики Помогите документы. Vimwiki в настоящее время отправляется с 3 синтаксисами: Vimwiki (по умолчанию), Markdown (Markdown) и MediaWiki (Media). Из них наилучшим образом поддерживается нативный синтаксис Вимвики, за которым следует отметка. Для Mediawiki не дано обещаний.
Примечание. Только синтаксис по умолчанию корабли со встроенным HTML-преобразователем. Для Markdown или MediaWiki см :h vimwiki-option-custom_wiki2html . Некоторые примеры и сторонние инструменты доступны здесь.
Если вы предпочитаете использовать синтаксисы Marckdown или MediaWiki, установите следующую опцию в своем .vimrc :
let g: vimwiki_list = [{ ' path ' : ' ~/vimwiki/ ' ,
' syntax ' : ' markdown ' , ' ext ' : ' md ' }]
Эта опция будет относиться к всем файлам разметки в вашей системе как часть Vimwiki (проверьте set filetype? ). Добавлять
let g: vimwiki_global_ext = 0 к вашему .vimrc , чтобы ограничить работу Вимвики только теми путями, перечисленными в g:vimwiki_list . Другие файлы разметки не будут рассматриваться как вики -страницы. См. G: vimwiki_global_ext.
Если вы хотите отключить поддержку другого расширения (например, отключение случайного создания нового вики и ссылки для обычных файлов маркировки), установите следующую опцию в своем .vimrc перед Packadd vimwiki:
let g: vimwiki_ext2syntax = {}См. G: Vimiki_ext2syntax
Проблемы GitHub являются основным методом для поднятия отчетов об ошибках или запросов функций.
Дополнительные ресурсы:
У Вимвики много пользователей, но только очень мало повторяющихся разработчиков или людей, помогающих сообществу. Поэтому ваша помощь ценится. Каждый может помочь! Смотрите #625 для получения информации о том, как вы можете помочь.
Кроме того, взгляните на Appling.md и Design_notes.md
MIT Лицензия
Copyright (C) 2008-2010 Maxim Kim 2013-2017 Daniel Schemala
Настоящим дается разрешение, бесплатно, любому лицу, получающему копию этого программного обеспечения и связанные с ними файлы документации («Программное обеспечение»), чтобы иметь дело в программном обеспечении без ограничений, включая, без ограничения, права на использование, копирование, изменение, объединение, публикацию, распределение, сублиценность и/или продавать копии программного обеспечения и разрешения лиц, на которые программное обеспечение подходит для того, чтобы поступить так, чтобы поступить на следующие условия: к следующим условиям: к следующим условиям: к следующим условиям: к следующим условиям: к следующим условиям: к следующим условиям: к следующим условиям: к следующим условиям: к следующим условиям: к следующим условиям: к следующим условиям: к следующим условиям: к следующим условиям: к следующим условиям: к следующим условиям: к следующим условиям: к следующим условиям: к следующим условиям: к следующим условиям: к следующим условиям: к следующим условиям: на следующие условия: к следующим условиям: на следующие условия: на следующие условия.
Вышеуказанное уведомление об авторском праве и это уведомление о разрешении должно быть включено во все копии или существенные части программного обеспечения.
Программное обеспечение предоставляется «как есть», без гарантии любого рода, явного или подразумеваемого, включая, помимо прочего, гарантии товарной пригодности, пригодности для определенной цели и несоответствия. Ни в коем случае авторы или владельцы авторских прав не будут нести ответственность за любые претензии, убытки или другую ответственность, будь то в действии контракта, деликт или иным образом, возникающие из или в связи с программным обеспечением или использованием или другими сделками в программном обеспечении.
