vimwiki.html

<!--
8"""8 8"""" 8"""8  8""""8 8""""8   8   8 8""""8 8""""
8   8 8     8   8  8    8 8    8   8   8 8    8 8
8e  8 8eeee 8eee8e 8e   8 8eeee8ee 8e  8 8e   8 8eeee
88  8 88    88   8 88   8 88     8 88  8 88   8 88
88  8 88    88   8 88   8 88     8 88  8 88   8 88
88  8 88eee 88   8 88eee8 88eeeee8 88ee8 88eee8 88eee

[website] https://www.nerdbude.com
[mail] post@nerdbude.com
[twitter] @PH_0x17
[github] https://www.github.com/nerdbude
 -->

<!DOCTYPE html>
<html>
<head>
    <title>NERDBUDE</title>
    <meta charset="utf-8" />
    <meta name="twitter:card" content="summary">
    <meta name="twitter:site" content="@PH_0x17">

    <meta property="og:url" content="https://www.nerdbude.com/vimwiki.html">
    <meta property="og:title" content="Alles organisieren mit Vim">
    <meta property="og:description" content="Ich habe selten ein besseres plugin zur Verbesserung des Workflows gesehen wie vimwiki.">

    <meta property="og:image" content="https://www.nerdbude.com/images/fav.png">
    <link rel="icon" type="image/png" href="https://www.nerdbude.com/images/fav.png">
    <link rel="alternate" href="https://nerdbude.com/rss/rss.xml" type="application/rss+xml" title="NERDBUDE"/>
    <link rel="stylesheet" type="text/css" href="css/style.css" media="screen">
</head>

<body>
  <!--- HEADER -->
  <header>
    <div id="headerimage">
      <h1 id="terminal"><a href="https://www.nerdbude.com" class="front">NERDBUDE</a></h1>
      <h3>[ code. keyboards. terminals. cyber. ]</h3>
      <table>
	      <tr>
		      <th><a href="https://www.nerdbude.com/readme.html" class="front">[HOWTO]</a></th>
          <th><a href="https://www.nerdbude.com/about.html" class="front">[WHOAMI]</a></th>
          <th><a href="https://www.nerdbude.com/podcast/index.html" class="front">[PODCAST]</a></th>
          <th><a href="https://www.nerdbude.com/frankenswitches.html" class="front">[FRANKENSWITCHES]</a></th>
          <th><a href="https://www.nerdbude.com/en/en_vimwiki.html" class="front">[ENGLISH]</a></th>
	      </tr>
      </table>
    </div>
  </header>


  <div id="content">
<!-- ARTIKLE START -->
<h2>vimwiki</h2>
<time>2021-09-28</time><br><br>
Manchmal lernt man alte tools und Plugins erst nach langer Zeit lieben.<br>
So ging es mir bei vimwiki.<br>
<br>
Irgendwie brauche ich doch immer wieder die gleichen Infos im Alltag. Sei es beim Coden, Basteln, Podcasten und und und.<br>
Was sich da anbietet ist eine eigene Knowledgebase (die sich einfach erweitern und bearbeiten lässt).<br>
Also quasi ein Wiki um die eigenen Gedankenbits zu sortiereni und das am besten für die Commandline ...  Hier kommt vimwiki ins Spiel.<br>
<br>
vimwiki baut ein eigenes kleines lokales Wiki, dass sich mit Markdown in Vim stylen lässt und Verlinkungen innerhalb von Dokumenten zulässt.<br>
Also alles was gebraucht wird zum organisieren der eigenen Gedanken.<br>
<br>
<h2>Installation</h2>
Wie kommt nun vimwiki in Vim.<br>
vimwiki läuft in jedem Vim ab Version 7.3<br>
<br>
Vorab sollten in der "vimrc" folgende Einträge gemacht werden oder vorhanden sein:<br>
<br>
<span class="label">vimrc</span>
<div id="cssyn">
  <ln><span class="value">set nocompatible</span></ln><br>
  <ln><span class="value">filetype plugin on</span></ln><br>
  <ln><span class="value">syntax on</span></ln><br>
</div>
<br>
Nun kann vimwiki installiert werden.<br>
<br>
<span class="label">Vim packages</span>
<div id="cssyn">
  <ln><span class="value">git clone https://github.com/vimwiki/vimwiki.git ~/.vim/pack/plugins/start/vimwiki</span></ln><br>
</div>
<br>
<span class="label">Pathogen</span>
<div id="cssyn">
  <ln><span class="value">cd ~/.vim</span></ln><br>
  <ln><span class="value">mkdir bundle</span></ln><br>
  <ln><span class="value">cd bundle</span></ln><br>
  <ln><span class="value">git clone https://github.com/vimwiki/vimwiki.git</span></ln><br>
</div>
<br>
<br>
<span class="label">Vim Plug</span>
<div id="cssyn">
  <ln><span class="value">Plug 'vimwiki/vimwiki'</span></ln><br>
  <ln><span class="value">:PlugInstall</span></ln><br>
</div>
<br>
<br>
Danach kann vimwiki in Vim benutzt werden.<br>
vimwiki kann grundsätzlich über drei verschiedene Syntax formatiert werden: vimwiki (default), Markdown und MediaWiki.<br>
Die Syntax die vimwiki benutzen soll, kann ebenfalls in der ".vimrc" definiert werden.<br>
<br>
<span class="label">.vimrc</span>
<div id="cssyn">
  <ln><span class="value">let g:vimwiki_list = [{'path': '~/vimwiki/',</span></ln><br>
  <ln><span class="value">\ 'syntax': 'markdown', 'ext': '.md'}]</span></ln><br>
</div>
<br>
<br>
Prinzipiell empfiehlt sich auch die Helpfiles für vimwiki zu installieren.<br>
<br>
<span class="label">Terminal</span>
<div id="cssyn">
  <ln><span class="value">vim -c 'helptags ~/.vim/pack/plugins/start/vimwiki/doc' -c quit</span></ln><br>
</div>
<br>
<br>
Wenn das erledigt ist - kanns los gehen.<br>
<br>
<h3>Benutzung</h3>
Wie es Vim schon macht, wird auch vimwiki rein per Tastatur und Tastenkombinationen gesteuert.<br>
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):<br>
<br>
<span class="label">KEYBINDINGS</span>
<div id="cssyn">
  <ln><span class="value">[LEADER] ww -- öffnet das wiki index file</span></ln><br>
  <ln><span class="value">[LEADER] wt -- öffnet die index file in einem neuen Tab</span></ln><br>
  <ln><span class="value">[LEADER] ws -- öffnet ausgewählte index file</span></ln><br>
  <ln><span class="value">[LEADER] wd -- löscht das aktuelle wikifile</span></ln><br>
  <ln><span class="value">[LEADER] wr -- benennt das aktuelle wikifile um</span></ln><br>
  <ln><ln><br>
  <ln><span class="value">[ENTER] -- Link folgen / Link erstellen</span></ln><br>
  <ln><span class="value">[BACKSPACE] -- Zurück zur letzten Wiki Seite</span></ln><br>
</div>
<br>
<br>
Damit lässt sich vimwiki nun bedienen.<br>
Jetzt können wir vimwiki installieren, grundsätzlich konfigurieren und auch bedienen.<br>
Nun ist aber noch kein Inhalt da. Bevor die Knowledgebase gefüllt wird, müssen Überlegungen zur Struktur gemacht werden, das erspart viel Nacharbeit.<br>
Wenn die grobe Struktur steht, kann die Indexfile erstellt werden.<br>
Die vimwiki eigene Syntax ist relativ simpel und Markdown nicht ganz unähnlich.<br>
<br>
<h3>vimwiki Syntax</h3>
Zum Stylen der Indexfile und der einzelnen vimwiki Seiten können folgende Tags benutzt werden:<br>
<br>
= H1 =<br>
== H2 ==<br>
=== H3 ===<br>
<br>
*bold* (fett)<br>
_italic_ (kursiv)<br>
<br>
[[Link]] (Einfacher interner Link)<br>
[[Link|Beschreibung]] (Einfacher interner Link | Anzeigename im Wikifile)<br>
<br>
* Liste Pos 1<br>
* Liste Pos 2<br>
<br>
- Liste Pos 1<br>
- Liste Pos 2<br>
<br>
1. Liste Pos 1<br>
2. Liste Pos 2<br>
<br>
Für alle nutzbaren Syntaxtags kann immer die interne Hilfe benutzt werden:<br>
<br>
<span class="label">VIM</span>
<div id="cssyn">
  <ln><span class="value">:h vimwiki-syntax</span></ln><br>
</div>
<br>
Eine weitere funktion ist der Export der Wikifiles in HTML.<br>
Dazu gibt es folgende Befehle die in Vim benutzt werden können:<br>
<br>
<span class="label">VIM</span>
<div id="cssyn">
  <ln><span class="value">:vimwiki2HTML (exportiert das aktuelle File als HTML)</span></ln><br>
  <ln><span class="value">:vimwikiAll2HTML (exportiert alle File als HTML)</span></ln><br>
</div>
<br>
<br>
vimwiki erleichtert den Alltag ungemein. Mit vimwiki kann nahezu alles organisiert werden:<br>
- Todo Listen<br>
- Tagebücher<br>
- Protokolle<br>
- Projektplanungen<br>
- Code Dokumentation<br>
<br>
und so ziemlich alles was einem einfällt. Das perfekte Plugin, wenn ihr auf bloat-ui-tools verzichten wollt.<br>
Jetzt brauch ich noch einen praktikablen Kalender für Vim, aber das ist eine andere Geschichte.<br>

<!-- ARTIKEL ENDE -->
<br>
<br>
<br>
<br>
<p>//EOF</p>
  </div>

  <!-- Footer -->

  <div id="footer">
    <a href="https://www.nerdbude.com/impressum.html">./impressum </a>
    <a target="_blank" href="https://www.nerdbude.com/datenschutz.html">./datenschutz </a>
  </div>

</body>
</html>