Skip to content

Commit 3fb095d

Browse files
Bundle both docsets together (#28)
Since GitHub insists on a zip file
1 parent 28e0e9e commit 3fb095d

File tree

2 files changed

+9
-15
lines changed

2 files changed

+9
-15
lines changed

.github/workflows/build.yml

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -29,16 +29,9 @@ jobs:
2929
- name: Build the docset
3030
run: |
3131
make
32-
make zip
3332
34-
- name: Upload the ST docset
33+
- name: Upload the docsets
3534
uses: actions/upload-artifact@v4
3635
with:
37-
name: sublime-text.docset.tgz
38-
path: out/sublime-text.docset.tgz
39-
40-
- name: Upload the SM docset
41-
uses: actions/upload-artifact@v4
42-
with:
43-
name: sublime-merge.docset.tgz
44-
path: out/sublime-merge.docset.tgz
36+
name: docset-bundle
37+
path: out/sublime-*.docset

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,24 @@
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.
4+
[documentation][st-docs]. There is also a small docset for [Sublime Merge][sm].
55

66

77
## Installation
88

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

11-
- If you have a `sublime-text.docset.tgz` from GitHub, extract it somewhere.
11+
- If you have a `docset-bundle.zip` from GitHub, extract it somewhere.
1212
- If you build yourself, `sublime-text.docset` will be in the
1313
`out` folder.
1414

1515
We hope to have a distribution channel [eventually][distribution].
1616

1717
### Install a local folder to Dash
1818

19+
It may be possible to just double-click `sublime-text.docset`,
20+
but that hasn't been tested. If that doesn't work:
21+
1922
1. Open Dash.
2023
1. <kbd>Cmd</kbd>+<kbd>,</kbd>
2124
1. Open the "Docsets" tab.
@@ -25,9 +28,6 @@ We hope to have a distribution channel [eventually][distribution].
2528
1. Optionally change the keyword.
2629
1. Repeat for `out/sublime-merge.docset`.
2730

28-
It may be possible to just double-click `sublime-text.docset`,
29-
but that hasn't been tested.
30-
3131
### Install a local folder to Zeal
3232

3333
If you have default Linux folders, `make install-linux`. Otherwise:
@@ -65,5 +65,6 @@ If you have default Linux folders, `make install-linux`. Otherwise:
6565
[Zeal]: https://zealdocs.org
6666
[st]: https://www.sublimetext.com/
6767
[st-docs]: https://www.sublimetext.com/docs/index.html
68+
[sm]: https://www.sublimemerge.com/
6869
[dashing]: https://github.com/technosophos/dashing#readme
6970
[distribution]: https://github.com/SublimeText/sublime-text-docset/issues/12

0 commit comments

Comments
 (0)