NERDBUDE

[ code. keyboards. terminals. cyber. ]

[HOWTO] [WHOAMI] [PODCAST] [ENGLISH]

vimwiki

Manchmal lernt man alte tools und Plugins erst nach langer Zeit lieben.
So ging es mir bei vimwiki.

Irgendwie brauche ich doch immer wieder die gleichen Infos im Alltag. Sei es beim Coden, Basteln, Podcasten und und und.
Was sich da anbietet ist eine eigene Knowledgebase (die sich einfach erweitern und bearbeiten lässt).
Also quasi ein Wiki um die eigenen Gedankenbits zu sortiereni und das am besten für die Commandline ... Hier kommt vimwiki ins Spiel.

vimwiki baut ein eigenes kleines lokales Wiki, dass sich mit Markdown in Vim stylen lässt und Verlinkungen innerhalb von Dokumenten zulässt.
Also alles was gebraucht wird zum organisieren der eigenen Gedanken.

Installation

Wie kommt nun vimwiki in Vim.
vimwiki läuft in jedem Vim ab Version 7.3

Vorab sollten in der "vimrc" folgende Einträge gemacht werden oder vorhanden sein:

vimrc
set nocompatible
filetype plugin on
syntax on

Nun kann vimwiki installiert werden.

Vim packages
git clone https://github.com/vimwiki/vimwiki.git ~/.vim/pack/plugins/start/vimwiki

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


Vim Plug
Plug 'vimwiki/vimwiki'
:PlugInstall


Danach kann vimwiki in Vim benutzt werden.
vimwiki kann grundsätzlich über drei verschiedene Syntax formatiert werden: vimwiki (default), Markdown und MediaWiki.
Die Syntax die vimwiki benutzen soll, kann ebenfalls in der ".vimrc" definiert werden.

.vimrc
let g:vimwiki_list = [{'path': '~/vimwiki/',
\ 'syntax': 'markdown', 'ext': '.md'}]


Prinzipiell empfiehlt sich auch die Helpfiles für vimwiki zu installieren.

Terminal
vim -c 'helptags ~/.vim/pack/plugins/start/vimwiki/doc' -c quit


Wenn das erledigt ist - kanns los gehen.

Benutzung

Wie es Vim schon macht, wird auch vimwiki rein per Tastatur und Tastenkombinationen gesteuert.
Folgende Keybindings helfen bei der Steuerung ([LEADER] ist in der Standardconfig von Vim \, wenn ihr den LEADER anders gemappt habt, müsst ihr den natürlich nehmen):

KEYBINDINGS
[LEADER] ww -- öffnet das wiki index file
[LEADER] wt -- öffnet die index file in einem neuen Tab
[LEADER] ws -- öffnet ausgewählte index file
[LEADER] wd -- löscht das aktuelle wikifile
[LEADER] wr -- benennt das aktuelle wikifile um

[ENTER] -- Link folgen / Link erstellen
[BACKSPACE] -- Zurück zur letzten Wiki Seite


Damit lässt sich vimwiki nun bedienen.
Jetzt können wir vimwiki installieren, grundsätzlich konfigurieren und auch bedienen.
Nun ist aber noch kein Inhalt da. Bevor die Knowledgebase gefüllt wird, müssen Überlegungen zur Struktur gemacht werden, das erspart viel Nacharbeit.
Wenn die grobe Struktur steht, kann die Indexfile erstellt werden.
Die vimwiki eigene Syntax ist relativ simpel und Markdown nicht ganz unähnlich.

vimwiki Syntax

Zum Stylen der Indexfile und der einzelnen vimwiki Seiten können folgende Tags benutzt werden:

= H1 =
== H2 ==
=== H3 ===

*bold* (fett)
_italic_ (kursiv)

[[Link]] (Einfacher interner Link)
[[Link|Beschreibung]] (Einfacher interner Link | Anzeigename im Wikifile)

* Liste Pos 1
* Liste Pos 2

- Liste Pos 1
- Liste Pos 2

1. Liste Pos 1
2. Liste Pos 2

Für alle nutzbaren Syntaxtags kann immer die interne Hilfe benutzt werden:

VIM
:h vimwiki-syntax

Eine weitere funktion ist der Export der Wikifiles in HTML.
Dazu gibt es folgende Befehle die in Vim benutzt werden können:

VIM
:vimwiki2HTML (exportiert das aktuelle File als HTML)
:vimwikiAll2HTML (exportiert alle File als HTML)


vimwiki erleichtert den Alltag ungemein. Mit vimwiki kann nahezu alles organisiert werden:
- Todo Listen
- Tagebücher
- Protokolle
- Projektplanungen
- Code Dokumentation

und so ziemlich alles was einem einfällt. Das perfekte Plugin, wenn ihr auf bloat-ui-tools verzichten wollt.
Jetzt brauch ich noch einen praktikablen Kalender für Vim, aber das ist eine andere Geschichte.




//EOF