Merge branch 'master' of ssh://git.ikiwiki.info/srv/git/ikiwiki.info
[ikiwiki.git] / doc / tips / vim_and_ikiwiki.mdwn
1 # Vim and ikiwiki
2
3 ## Syntax highlighting
4
5 [ikiwiki-syntax](http://www.vim.org/scripts/script.php?script_id=3156) is a vim
6 syntax highlighting file for ikiwiki [[ikiwiki/markdown]] files. It highlights
7 directives and wikilinks. It only supports prefixed directives, i.e.,
8 \[[!directive foo=bar baz]], not the old format with spaces.
9
10 ------
11
12 The previous syntax definition for ikiwiki links is at [[vim_syntax_highlighting/ikiwiki.vim]]; however,
13 it seems to not be [[maintained
14 anymore|forum/navigation_of_wiki_pages_on_local_filesystem_with_vim#syn-maintenance]],
15 and it has some [[issues|forum/ikiwiki_vim_syntaxfile]].
16
17 ## Page creation and navigation
18
19 The [ikiwiki-nav](http://www.vim.org/scripts/script.php?script_id=2968) package
20 is a vim plugin that enables you to do the following from inside vim:
21
22   * Jumping to the file corresponding to the wikilink under the cursor.
23   * Creating the file corresponding to the wikilink under the cursor (including
24   directories if necessary.)
25   * Jumping to the previous/next wikilink in the current file.
26   * Autocomplete link names.
27
28 Download it from [here](http://www.vim.org/scripts/script.php?script_id=2968)