Sublime Text Docset

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

Installation

Install from a feed

This is likely more convenient because updates will be downloaded to your application automatically.

Dash

Dash has built-in support for their user-contributed docsets. Go to Preferences > Downloads > User Contributed to search for "Sublime" and install the community-org maintained ones.

Zeal

Zeal does not have a direct search for user-contributed docsets, but a third-party website repackages docset feeds in a compatible format. In Zeal, go to Tools > Docsets… > Add feed and paste in the URL to the respective feed:

https://zealusercontributions.vercel.app/api/docsets/Sublime_Text.xml

https://zealusercontributions.vercel.app/api/docsets/Sublime_Merge.xml

Install manually

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

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

Install a local folder to Dash

It may be possible to just double-click sublime-text.docset. If that doesn't work:

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

Install a local folder to Zeal

If you built yourself and you have default Linux folders, just make install-linux. Otherwise:

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

Building

Requirements

• make
• dashing
• Python 3.11+

Steps

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

   git submodule init
   pip install -r requirements.txt

2. Each build

   make

Credits

• Alex (Oleksii) Markov made the first version of this docset.
• Ali Ayas made the ST and SM docs scanners used here as submodules.
• Most recent development is Michael B. Lyons and FichteFoll.
• Many thanks to Sublime HQ for letting us make this.