*wiki-ft.txt* A simple `.wiki` filetype plugin for Vim

Author: Karl Yngve Lervåg <karl.yngve@gmail.com>

License: MIT license {{{

Copyright (c) 2020 Karl Yngve Lervåg

Permission is hereby granted, free of charge, to any person obtaining a copy

of this software and associated documentation files (the "Software"), to

deal in the Software without restriction, including without limitation the

rights to use, copy, modify, merge, publish, distribute, sublicense, and/or

sell copies of the Software, and to permit persons to whom the Software is

furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in

all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING

FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS

IN THE SOFTWARE.

}}}

CONTENTS *wiki-ft-contents*

Introduction |wiki-ft-intro|

Syntax highlighting |wiki-ft-syntax|

Common elements |wiki-ft-syntax-common|

Links |wiki-ft-syntax-links|

Code blocks |wiki-ft-syntax-code|

Syntax highlighting |wiki-ft-mappings|

Text objects |wiki-ft-mappings-text-obj|

Default mappings |wiki-ft-mappings-default|

INTRODUCTION *wiki-ft-intro*

This is a simple filetype plugin for `.wiki` files that adds some syntax

highlighting and very simple folding functions. It depends on |wiki.vim|

(https://github.com/lervag/wiki.vim) for proper highlighting of links.

The folding function simply adds folds according to section depth.

If you use |vim-plug| (https://github.com/junegunn/vim-plug), then add the

following lines to your `vimrc` file: >

SYNTAX HIGHLIGHTING *wiki-ft-syntax*

This plugin supports a relatively standard type of simple Markdown syntax.

COMMON ELEMENTS *wiki-ft-syntax-common*

The following listing shows the set of common syntax elements that are

currently supported: >

LINKS *wiki-ft-syntax-links*

A link typically consists of an url and a description, although the

description may be ignored. The links will be highlighted and the |+conceal|

feature is used to only display the descriptions if they are present.

The following listing shows some examples of links. >

URLs are also highlighted directly, e.g.: >

CODE BLOCKS *wiki-ft-syntax-code*

Code blocks are blocks like the following: >

If the code block has a language specifier, then the block will be highlighted

accordingly.

Note: The file is parsed when opened for code blocks, and only the languages

detected are highlighted. Thus, if one adds a new code block with a new

language, one may need to reload the file to get the appropriate

highlighting.

MAPPINGS *wiki-ft-mappings*

Here we describe the mappings provided by the wiki plugin, as well as the

default maps.

TEXT OBJECTS *wiki-ft-mappings-text-obj*

The following mappings are available as visual mode and operator mode

mappings, i.e. |xmap| and |omap|.

Text object for code blocks.

DEFAULT MAPPINGS *wiki-ft-mappings-default*

This is a list of default mappings. For a more detailed description of each

mapping, read the documentation of the `<plug>(wiki-[name])` form of the

mapping. The mode specifier is a single letter which indicates which mode the

mapping is valid in. See e.g. |nmap|, |imap|, |omap| or |xmap| for more

information about the different modes.

`ox` ac |<plug>(wiki-ac)|

`ox` ic |<plug>(wiki-ic)|

vim:tw=78:ts=8:ft=help:norl: