-
Notifications
You must be signed in to change notification settings - Fork 3
/
index.html
206 lines (160 loc) · 7.01 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
<!doctype html>
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="chrome=1">
<title>Vimwiki by vimwiki</title>
<link rel="stylesheet" href="stylesheets/styles.css">
<link rel="stylesheet" href="stylesheets/github-light.css">
<script src="javascripts/scale.fix.js"></script>
<meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
</head>
<body>
<div class="wrapper">
<header>
<h1 class="header">Vimwiki</h1>
<p class="header">A personal wiki for Vim</p>
<ul>
<li><a class="buttons github" href="https://github.com/vimwiki">GitHub Profile</a></li>
</ul>
</header>
<main>
<p>Vimwiki is a personal wiki for Vim – interlinked, plain text files written in a markup language</p>
<section>
<h1>
<a id="with-vimwiki-you-can" class="anchor" href="#with-vimwiki-you-can" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>With Vimwiki you can</h1>
<ul>
<li>organize notes and ideas and quickly create links between them</li>
<li>manage todo-lists</li>
<li>write a diary</li>
</ul>
<h2>
<a id="features" class="anchor" href="#features" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Features</h2>
<ul>
<li>three markup syntaxes supported: Vimwiki's own syntax, Markdown, MediaWiki</li>
<li>export everything to HTML</li>
<li>link to other wiki pages and external files</li>
<li>search through all wiki pages</li>
<li>outline notes and tasks in indented lists</li>
<li>quickly manipulate numbered and bulleted lists</li>
<li>tag wiki pages or arbitrary places and quickly jump to tags</li>
<li>auto-formatted tables</li>
</ul>
</section>
<h2>
<a id="screenshots" class="anchor" href="#screenshots" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Screenshots</h2>
<p><img src="https://raw.githubusercontent.com/vimwiki/vimwiki/master/doc/screenshot_1.png" alt="screenshot1">
<img src="https://raw.githubusercontent.com/vimwiki/vimwiki/master/doc/screenshot_2.png" alt="screenshot2"></p>
<section>
<h1>
<a id="quickstart" class="anchor" href="#quickstart" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Quickstart</h1>
<p>Press <code><Leader>ww</code> (this is usually <code>\ww</code>) to go to your index
page. By default it is located in <code>~/vimwiki/index.wiki</code>.</p>
<p>Feed it with the following example:</p>
<pre><code>= My knowledge base =
* Tasks -- things to be done _yesterday_!!!
* Project Gutenberg -- good books are power.
* Scratchpad -- various temporary stuff.
</code></pre>
<p>Place your cursor on <code>Tasks</code> and press Enter to create a link. Press Enter again to
open it. Edit the new page, save it, and press Backspace to jump back to your
index.</p>
<p>A Vimwiki link can be constructed from more than one word. Just visually
select the words to be linked and press Enter. Try it with <code>Project Gutenberg</code>.
The result should look something like:</p>
<pre><code>= My knowledge base =
* [[Tasks]] -- things to be done _yesterday_!!!
* [[Project Gutenberg]] -- good books are power.
* Scratchpad -- various temporary stuff.
</code></pre>
<p>See <code>:h vimwiki</code> for the full documentation.</p>
<h2>
<a id="basic-markup-default-syntax" class="anchor" href="#basic-markup-default-syntax" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Basic markup (default syntax)</h2>
<pre><code>= Header1 =
== Header2 ==
=== Header3 ===
*bold text*
_italic text_
[[wiki link]]
[[wiki link|description]]
* bullet list item 1
* bullet list item 2
a) numbered list item 1
b) numbered list item 2
{{{python
def greet(s):
print("Hello, " + s)
}}}
| a table | |
|---------|--|
| | |
</code></pre>
<p>For other syntax elements, see <code>:h vimwiki-syntax</code></p>
<h2>
<a id="key-bindings" class="anchor" href="#key-bindings" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Key bindings</h2>
<ul>
<li>
<code><Leader>ww</code> – Open the default wiki index file</li>
<li>
<code><Leader>ws</code> – Select and open wiki index file</li>
<li>
<code><Enter></code> – Follow/Create wiki link</li>
<li>
<code><Backspace></code> – Go back to parent(previous) wiki link</li>
<li>
<code><Tab></code> – Find next wiki link</li>
<li>
<code><Shift-Tab></code> – Find previous wiki link</li>
</ul>
<p>For more keys, see <code>:h vimwiki-mappings</code></p>
<h2>
<a id="commands" class="anchor" href="#commands" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Commands</h2>
<ul>
<li>
<code>:Vimwiki2HTML</code> – Convert current wiki page to HTML</li>
<li>
<code>:VimwikiAll2HTML</code> – Convert all your wiki pages to HTML</li>
</ul>
<p>For more, see <code>:h vimwiki-commands</code></p>
</section>
<section>
<h1>
<a id="installation" class="anchor" href="#installation" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Installation</h1>
<p>Use the Plugin-manager of your choice to install vimwiki.</p>
<h2>
<a id="prerequisites" class="anchor" href="#prerequisites" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Prerequisites</h2>
<p>Make sure you have these settings in your vimrc file:</p>
<pre><code>set nocompatible
filetype plugin on
syntax on
</code></pre>
<p>Without them Vimwiki will not work properly.</p>
<h2>
<a id="installation-using-plug" class="anchor" href="#installation-using-plug" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Installation using <a href="https://github.com/junegunn/vim-plug">Vim-Plug</a>
</h2>
<p>Add the following to the plugin-configuration in your vimrc:</p>
<pre><code>Plug 'vimwiki/vimwiki'
</code></pre>
<p>Then run <code>:PlugInstall</code>.</p>
<h2>
<a id="installation-using-pathogen" class="anchor" href="#installation-using-pathogen" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Installation using <a href="http://www.vim.org/scripts/script.php?script_id=2332">Pathogen</a>
</h2>
<pre><code>cd ~/.vim
mkdir bundle
cd bundle
git clone https://github.com/vimwiki/vimwiki.git
</code></pre>
<p>Alternatively, download the latest version (<a href="http://github.com/vimwiki/vimwiki/zipball/master">zip</a>, <a href="http://github.com/vimwiki/vimwiki/tarball/master">tar</a>) and extract it into <code>~/.vim/bundle/</code></p>
<p>Then launch Vim, run <code>:Helptags</code> and then <code>:help vimwiki</code> to verify it was installed.</p>
</section>
</main>
<footer>
<p><small>Hosted on <a href="https://pages.github.com">GitHub Pages</a> using the Dinky theme</small></p>
</footer>
</div>
<!--[if !IE]><script>fixScale(document);</script><![endif]-->
</body>
</html>