|
1 | | -# Sublime Text Docset |
| 1 | +# [Sublime Text Docset][self] |
2 | 2 |
|
3 | 3 | [Dash][] and [Zeal][] docset for [Sublime Text][st]’s official |
4 | 4 | [documentation][st-docs]. |
5 | 5 |
|
| 6 | + |
| 7 | +## Installation |
| 8 | + |
| 9 | +Download from GitHub Releases or build yourself with the instructions below. |
| 10 | + |
| 11 | +- If you have a `sublime-text.docset.zip` from GitHub, extract it to a |
| 12 | +folder called `sublime-text.docset`. |
| 13 | +- If you build yourself, `sublime-text.docset` will be in the |
| 14 | +`www.sublimetext.com` folder. |
| 15 | + |
| 16 | +We hope to have a distribution channel [eventually][distribution]. |
| 17 | + |
| 18 | +### Install a local folder to Dash |
| 19 | + |
| 20 | +1. Open Dash. |
| 21 | +1. <kbd>Cmd</kbd>+<kbd>,</kbd> |
| 22 | +1. Open the "Docsets" tab. |
| 23 | +1. Click the <kbd>+</kbd>. |
| 24 | +1. Choose "Add Local Docset". |
| 25 | +1. Select the `sublime-text.docset` in the `www.sublimetext.com` folder. |
| 26 | +1. Optionally change the keyword. |
| 27 | + |
| 28 | +### Install a local folder to Zeal |
| 29 | + |
| 30 | +1. Find your docset folder ("Docset storage" in your Preferences) |
| 31 | +1. Copy or symlink `sublime-text.docset` to that folder. |
| 32 | + |
| 33 | + |
6 | 34 | ## Building |
7 | 35 |
|
8 | 36 | ### Requirements |
9 | 37 |
|
10 | 38 | * `make` |
11 | 39 | * [`dashing`][dashing] |
12 | 40 | * `yq` |
13 | | -* `sed` (with `-E` support), `find`, `wget` |
| 41 | +* `sed` (with `-E` support) |
| 42 | +* `find` |
| 43 | +* `wget` |
14 | 44 | * Python 3.8+ |
15 | 45 |
|
16 | 46 | ### Steps |
|
22 | 52 | make |
23 | 53 | ``` |
24 | 54 |
|
25 | | -## Installation |
26 | | - |
27 | | -### Dash locally-built docset |
28 | | - |
29 | | -1. Open Dash. |
30 | | -1. <kbd>Cmd</kbd>+<kbd>,</kbd> |
31 | | -1. Open the "Docsets" tab. |
32 | | -1. Click the <kbd>+</kbd>. |
33 | | -1. Choose "Add Local Docset". |
34 | | -1. Select the `sublime-text.docset` in the `www.sublimetext.com` folder. |
35 | | -1. Optionally change the keyword. |
36 | | - |
37 | | -### Zeal locally-built docset |
38 | | - |
39 | | -1. Find your docset folder ("Docset storage" in your Preferences) |
40 | | -1. Copy or symlink `sublime-text.docset` to that folder. |
41 | 55 |
|
| 56 | +[self]: https://github.com/SublimeText/sublime-text-docset |
42 | 57 | [Dash]: https://kapeli.com/dash |
43 | 58 | [Zeal]: https://zealdocs.org |
44 | 59 | [st]: https://www.sublimetext.com/ |
45 | 60 | [st-docs]: https://www.sublimetext.com/docs/index.html |
46 | 61 | [dashing]: https://github.com/technosophos/dashing#readme |
| 62 | +[distribution]: https://github.com/SublimeText/sublime-text-docset/issues/12 |
0 commit comments