Sublime Text Docset

Dash and Zeal docset for Sublime Text’s official documentation. There is also a small docset for Sublime Merge.

Installation

Download from GitHub Releases or build yourself with the instructions below.

• If you have a sublime-text.docset.tgz from GitHub, extract it somewhere.
• If you build yourself, sublime-text.docset will be in the out folder.

We hope to have a distribution channel eventually.

Install a local folder to Dash

1. Open Dash.
2. Cmd+,
3. Open the "Docsets" tab.
4. Click the +.
5. Choose "Add Local Docset".
6. Select the sublime-text.docset in the out folder.
7. Optionally change the keyword.
8. Repeat for out/sublime-merge.docset.

It may be possible to just double-click sublime-text.docset, but that hasn't been tested.

Install a local folder to Zeal

If you have default Linux folders, make install-linux. Otherwise:

1. Find your docset folder ("Docset storage" in your Preferences)
2. Copy or symlink out/sublime-text.docset to that folder.
3. Repeat for out/sublime-merge.docset

Building

Requirements

• make
• dashing
• yq
• Python 3.8+

Steps

0. (Optional) Enter a Python virtual environment.
1. One time

   git submodule init
   pip install -r requirements.txt

2. Each build

   make