Skip to content

Some README cleanups #34

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
FichteFoll merged 1 commit into from
Nov 20, 2025
Merged

Some README cleanups #34

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 19 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,28 +1,38 @@
# [Sublime Text Docset][self]

[Dash][] and [Zeal][] docset for [Sublime Text][st]’s official
[documentation][st-docs]. There is also a small docset for [Sublime Merge][sm].
[documentation][st-docs].
There is also a small docset for [Sublime Merge][sm].


## 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*\
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-contrib docsets.

Zeal does not have a direct search for user-contributed docsets.
In Zeal, go to *Tools* > *Docsets…* > *Add feed*
and paste in the URL to a [third-party][zuc]'s repacked feed
[for Sublime Text][zuc-st-feed] or [for Sublime Merge][zuc-sm-feed].
and paste in the URL(s) to the respective [third-party][zuc]'s repacked 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][releases]
or build yourself with the instructions below.

Expand All @@ -31,6 +41,7 @@ or build yourself with the instructions below.
`out` folder.

#### Install a local folder to Dash

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

Expand All @@ -44,8 +55,10 @@ If that doesn't work:
1. 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:
just `make install-linux`.
Otherwise:

1. Find your docset folder ("Docset storage" in your Preferences).
1. Copy or symlink `sublime-text.docset` to that folder.
Expand Down Expand Up @@ -88,8 +101,6 @@ just `make install-linux`. Otherwise:
[st-docs]: https://www.sublimetext.com/docs/index.html
[sm]: https://www.sublimemerge.com/
[zuc]: https://zealusercontributions.vercel.app
[zuc-st-feed]: https://zealusercontributions.vercel.app/api/docsets/Sublime_Text.xml
[zuc-sm-feed]: https://zealusercontributions.vercel.app/api/docsets/Sublime_Merge.xml
[releases]: https://github.com/SublimeText/sublime-text-docset/releases
[dashing]: https://github.com/technosophos/dashing#readme

Expand Down
Loading