Skip to content
master
Switch branches/tags
Code

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

apiblueprint.vim

This vim plugin brings syntax highlighting and linting for API Blueprint.

API Blueprint Plugin Screenshot

Usage

The plugin adds an apiblueprint file type along with an apiblueprint syntax.

Linting

Using syntastic, your API Blueprint can be linted on each save. For this, you will need to install both drafter and syntastic.

Apiary

You can use the apiary client with this plugin to load a blueprint from Apiary directly providing apiary client is installed and configured.

$ vim apiary:pollsapi

Refract

Providing you have drafter installed. You can use GenerateRefract function to generate a preview of the Refract structure for your API Blueprint in a split.

You can manually map this function to a keyboard shortcut. For example to ctrl+b:

autocmd FileType apiblueprint nnoremap <C-b> :call GenerateRefract()<cr>

TagBar

If you have TagBar installed you can use it to list and jump to groups and resources.

Snippets

The are snippets in the snipMate format, supported by many Vim snippet plug-ins.

Installation

With vim-plug (recommended)

Add:

Plug 'kylef/apiblueprint.vim'

To your .vimrc and run PlugInstall inside vim.

With Vundle

Add:

Plugin 'kylef/apiblueprint.vim'

To your .vimrc and run PluginInstall from within vim or vim +PluginInstall +qall from the command line

With Pathogen

$ git clone https://github.com/kylef/apiblueprint.vim.git ~/.vim/bundle/apiblueprint.vim

About

This vim plugin brings syntax highlighting and linting for API Blueprint.

Resources

License

Releases

No releases published

Packages

No packages published