{"id":13495046,"url":"https://github.com/apiaryio/api-blueprint-sublime-plugin","last_synced_at":"2025-03-28T16:31:14.524Z","repository":{"id":11224370,"uuid":"13615147","full_name":"apiaryio/api-blueprint-sublime-plugin","owner":"apiaryio","description":"API Blueprint Sublime Text plugin","archived":false,"fork":false,"pushed_at":"2018-09-04T13:19:05.000Z","size":67,"stargazers_count":176,"open_issues_count":8,"forks_count":20,"subscribers_count":22,"default_branch":"master","last_synced_at":"2024-10-31T10:36:22.357Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/apiaryio.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-10-16T09:38:20.000Z","updated_at":"2024-01-03T14:10:52.000Z","dependencies_parsed_at":"2022-08-29T17:31:56.384Z","dependency_job_id":null,"html_url":"https://github.com/apiaryio/api-blueprint-sublime-plugin","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apiaryio%2Fapi-blueprint-sublime-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apiaryio%2Fapi-blueprint-sublime-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apiaryio%2Fapi-blueprint-sublime-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apiaryio%2Fapi-blueprint-sublime-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/apiaryio","download_url":"https://codeload.github.com/apiaryio/api-blueprint-sublime-plugin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246062691,"owners_count":20717681,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-07-31T19:01:30.691Z","updated_at":"2025-03-28T16:31:14.183Z","avatar_url":"https://github.com/apiaryio.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"# API Blueprint Sublime Text Plugin\nThis is the official [API Blueprint](http://apiblueprint.org/) plugin for [Sublime Text](http://www.sublimetext.com) with following features:\n\n- Syntax highlighting for the `API Blueprint` format\n- Compiling blueprint into its [AST media-type](https://github.com/apiaryio/api-blueprint-ast#ast-description)\n- Live linting of blueprints as you type using `SublimeLinter3`\n\nThis plug-in works both with **Sublime Text 2 and 3**. However linting is supported on Sublime Text 3 only.\n\n## Requirements\n### Drafter\nIn order for this plugin to work properly you need to have the API Blueprint command line tool `drafter` installed.\n\nTo install `Drafter` on OS X using run the following command:\n\n```sh\n$ brew install drafter\n```\n\nRefer to [Drafter](https://github.com/apiaryio/drafter#install) installation notes for details on installing on [OS X \u0026 Linux](https://github.com/apiaryio/drafter#drafter-command-line-tool) or [Windows](https://github.com/apiaryio/drafter/wiki/Building-on-Windows).\n\n### SublimeLinter3 (optional)\nThis plugin offers linting of your blueprints using the [SublimeLinter3](https://github.com/SublimeLinter/SublimeLinter3) plugin framework. In order for linting to work please [install](http://sublimelinter.readthedocs.org/en/latest/installation.html) `SublimeLinter3`.\n\n### Markdown Highlighting (optional)\nNote 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](https://github.com/jonschlinkert/sublime-monokai-extended), and install [Sublime Markdown Extended](https://github.com/jonschlinkert/sublime-markdown-extended).\n\n## Installation\n### Using Package Control\n\nWith [Package Control](https://packagecontrol.io/installation):\n\n1. Run “Package Control: Install Package” command, find and install `API Blueprint` plugin.\n2. Restart SublimeText editor (if required)\n\n### From the Source\nWith `Drafter` [installed](#requirements) run the following command in your Sublime Text 3 packages directory:\n\n```sh\n$ git clone https://github.com/apiaryio/api-blueprint-sublime-plugin.git  \"API Blueprint\"\n```\n\nDepending on your OS (and Sublime Text version) the packages directories are:\n+ Linux: `~/.config/sublime-text-3/packages`\n+ OS X: `~/Library/Application\\ Support/Sublime\\ Text\\ 3/Packages`\n+ Windows: `%APPDATA%\\Sublime Text 3\\Packages`\n\n## Using the Plugin\n### Commands\nYou can access the commands either using the command palette (`CTRL+SHIFT+P` or `CMD+SHIFT+P`) or via shortcuts.\n\n### Shortcuts\n- `ALT+SHIFT+B`: Parse the active file and open result [AST](https://github.com/apiaryio/api-blueprint-ast#ast-description) including any possible parser messages in a new tab.\n\n## Acknowledgements\n+ This plugin uses parts of [CoffeeScript Sublime Plugin](http://xavura.github.com/CoffeeScript-Sublime-Plugin).\n+ Thanks to [@WMeldon](https://github.com/WMeldon) for his contribution.\n\n## License\nMIT License. See the [LICENSE](LICENSE) file.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapiaryio%2Fapi-blueprint-sublime-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fapiaryio%2Fapi-blueprint-sublime-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapiaryio%2Fapi-blueprint-sublime-plugin/lists"}