Skip to content

mjakl/vim-asciidoc

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Asciidoc

Asciidoc is a document markup language that is more powerful than Markdown, but still human readable.

It covers a big range of document types you can write. From notes and simple README files to full books.

For more information on Asciidoc, have a look at its homepage (Asciidoc) and especially at the Asciidoctor project (Asciidoctor).

mjakl/vim-asciidoc

This Vim plugin adds Asciidoc and Asciidoctor syntax highlighting, and folding capabilities.

Foldlevels are computed by the number of = at the start of the line.

It also includes snippets that can be used with UltiSnips.

The commentstring and comments variables are set to Asciidoc compatible values.

Installation

Vundle

Plugin 'mjakl/vim-asciidoc'

Configuration

To disable the folding of Asciidoc headers, add this to your .vimrc:

let g:vim_asciidoc_folding_disabled=0

The default foldlevel after loading an Asciidoc file is 0, you can configure that (1 is a good choice):

let g:vim_asciidoc_initial_foldlevel=1

Snippets

Asciidoc does not contain much boilerplate, but some things are repetetive, the plugin includes UltiSnips snippets to make these few cases as pleasant as possible.

  • doc Insert document header
  • source Insert a source code block
  • quote Insert a new quote block

Credits

The plugin is based on the work of many people, especially the creators of these projects:

About

Asciidoc syntax and configuration for Vim

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Vim Script 100.0%