Skip to content

Commit 97f9a30

Browse files
committed
Some README cleanups
- Show feed URLs as code blocks as they can be easily copied with a click of a button and the URL is immediately readable. - Consistent spacing around headings.
1 parent 30b606e commit 97f9a30

File tree

1 file changed

+19
-8
lines changed

1 file changed

+19
-8
lines changed

README.md

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,38 @@
11
# [Sublime Text Docset][self]
22

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

67

78
## Installation
89

910
### Install from a feed
11+
1012
This is likely more convenient because updates will be downloaded
1113
to your application automatically.
1214

1315
#### Dash
16+
1417
Dash has built-in support for their user-contributed docsets.
15-
Go to *Preferences* > *Downloads* > *User Contributed*\
18+
Go to *Preferences* > *Downloads* > *User Contributed*
1619
to search for "Sublime" and install the community-org maintained ones.
1720

1821
#### Zeal
19-
Zeal does not have a direct search for user-contrib docsets.
22+
23+
Zeal does not have a direct search for user-contributed docsets.
2024
In Zeal, go to *Tools* > *Docsets…* > *Add feed*
21-
and paste in the URL to a [third-party][zuc]'s repacked feed
22-
[for Sublime Text][zuc-st-feed] or [for Sublime Merge][zuc-sm-feed].
25+
and paste in the URL(s) to the respective [third-party][zuc]'s repacked feed:
2326

27+
```
28+
https://zealusercontributions.vercel.app/api/docsets/Sublime_Text.xml
29+
```
30+
```
31+
https://zealusercontributions.vercel.app/api/docsets/Sublime_Merge.xml
32+
```
2433

2534
### Install manually
35+
2636
Download from [GitHub Releases][releases]
2737
or build yourself with the instructions below.
2838

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

3343
#### Install a local folder to Dash
44+
3445
It may be possible to just double-click `sublime-text.docset`.
3546
If that doesn't work:
3647

@@ -44,8 +55,10 @@ If that doesn't work:
4455
1. Repeat for `sublime-merge.docset`.
4556

4657
#### Install a local folder to Zeal
58+
4759
If you built yourself and you have default Linux folders,
48-
just `make install-linux`. Otherwise:
60+
just `make install-linux`.
61+
Otherwise:
4962

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

0 commit comments

Comments
 (0)