API Blueprint
API Blueprint Sublime Text plugin
Details
Installs
- Total 14K
- Win 4K
- Mac 8K
- Linux 2K
Apr 1 | Mar 31 | Mar 30 | Mar 29 | Mar 28 | Mar 27 | Mar 26 | Mar 25 | Mar 24 | Mar 23 | Mar 22 | Mar 21 | Mar 20 | Mar 19 | Mar 18 | Mar 17 | Mar 16 | Mar 15 | Mar 14 | Mar 13 | Mar 12 | Mar 11 | Mar 10 | Mar 9 | Mar 8 | Mar 7 | Mar 6 | Mar 5 | Mar 4 | Mar 3 | Mar 2 | Mar 1 | Feb 28 | Feb 27 | Feb 26 | Feb 25 | Feb 24 | Feb 23 | Feb 22 | Feb 21 | Feb 20 | Feb 19 | Feb 18 | Feb 17 | Feb 16 | |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Windows | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 |
Mac | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 |
Linux | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 |
Readme
- Source
- raw.githubusercontent.com
API Blueprint Sublime Text Plugin
This is the official API Blueprint plugin for Sublime Text with following features:
- Syntax highlighting for the
API Blueprint
format - Compiling blueprint into its AST media-type
- Live linting of blueprints as you type using
SublimeLinter3
This plug-in works both with Sublime Text 2 and 3. However linting is supported on Sublime Text 3 only.
Requirements
Drafter
In order for this plugin to work properly you need to have the API Blueprint command line tool drafter
installed.
To install Drafter
on OS X using run the following command:
$ brew install drafter
Refer to Drafter installation notes for details on installing on OS X & Linux or Windows.
SublimeLinter3 (optional)
This plugin offers linting of your blueprints using the SublimeLinter3 plugin framework. In order for linting to work please install SublimeLinter3
.
Markdown Highlighting (optional)
Note the API Blueprint Sublime Text syntax support relies on Markdown highlighing support in the color scheme used. For best results use a color scheme that supports Markdown-specific scopes (e.g. markdown: heading
) such as Monokai extended, and install Sublime Markdown Extended.
Installation
Using Package Control
With Package Control:
- Run “Package Control: Install Package” command, find and install
API Blueprint
plugin. - Restart SublimeText editor (if required)
From the Source
With Drafter
installed run the following command in your Sublime Text 3 packages directory:
$ git clone https://github.com/apiaryio/api-blueprint-sublime-plugin.git "API Blueprint"
Depending on your OS (and Sublime Text version) the packages directories are:
+ Linux: ~/.config/sublime-text-3/packages
+ OS X: ~/Library/Application\ Support/Sublime\ Text\ 3/Packages
+ Windows: %APPDATA%\Sublime Text 3\Packages
Using the Plugin
Commands
You can access the commands either using the command palette (CTRL+SHIFT+P
or CMD+SHIFT+P
) or via shortcuts.
Shortcuts
ALT+SHIFT+B
: Parse the active file and open result AST including any possible parser messages in a new tab.
Acknowledgements
- This plugin uses parts of CoffeeScript Sublime Plugin.
- Thanks to @WMeldon for his contribution.
License
MIT License. See the LICENSE file.