このプロジェクトについて

VimWikiはVim用の個人用Wikiプラグインで、プレーンテキストファイルを独自の構文ハイライト付きのリンクされた知識ベースに変換します。メモやアイデアの整理、ToDoリストの管理、ドキュメントの作成、日記の維持を目的として設計されており、すべてをHTMLにエクスポートする機能も備えています。 このプラグインはVim 7.3以上で動作し、NeoVimでも動作することが知られていますが、NeoVim固有のバグが存在する可能性があります。インストールはVimのネイティブパッケージシステム、Pathogen、Vim-Plug、Vundle、Lazy.nvim、または手動ダウンロードでサポートされています。 VimWikiは、見出し、太字や斜体のテキスト、Wikiリンク、箇条書きや番号付きリスト、完了状態付きのToDoリストのためのシンプルなマークアップ構文を提供します。Wikiリンクは、カーソルをテキストに置いてEnterキーを押すことで作成され、テキストが二重角括弧で囲まれます。複数単語のリンクは、先に単語をビジュアル選択することで作成できます。 ナビゲーションはキーバインドで処理されます。EnterキーでWikiリンクをたどるか作成し、Backspaceで親ページに戻り、TabとShift-Tabでリンクを循環し、Shift-EnterまたはCtrl-Enterでリンクを分割ウィンドウで開きます。デフォルトのインデックスファイルは~/vimwiki/index.wikiにあり、Leader-wwショートカットで開けます。 VimWikiには3つの構文モードが付属しています。ネイティブのVimWiki構文(最もサポートが充実)、Markdown、MediaWikiです。ネイティブ構文のみが組み込みのHTMLコンバーターを含み、MarkdownやMediaWikiユーザーは外部コンバーターを設定できます。プラグインは、特定の拡張子のすべてのファイルをWikiページとして扱うか、特定のパスに制限するように設定できます。 コマンドには、現在のページを変換するVimwiki2HTMLと、すべてのWikiページを変換するVimwikiAll2HTMLが含まれます。完全なドキュメントは:help vimwikiで参照できます。 このプロジェクトはMITライセンスの下で提供され、GitHubのIssueやLibera ChatのIRCチャンネルを通じて貢献を歓迎しています。