Skip to content

Bundle both docsets together #28

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
michaelblyons merged 1 commit into from
Nov 11, 2025
Merged

Bundle both docsets together #28

Show file tree
Hide file tree
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
13 changes: 3 additions & 10 deletions .github/workflows/build.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,16 +29,9 @@ jobs:
- name: Build the docset
run: |
make
make zip

- name: Upload the ST docset
- name: Upload the docsets
uses: actions/upload-artifact@v4
with:
name: sublime-text.docset.tgz
path: out/sublime-text.docset.tgz

- name: Upload the SM docset
uses: actions/upload-artifact@v4
with:
name: sublime-merge.docset.tgz
path: out/sublime-merge.docset.tgz
name: docset-bundle
path: out/sublime-*.docset
11 changes: 6 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,21 +1,24 @@
# [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.
[documentation][st-docs]. There is also a small docset for [Sublime Merge][sm].


## Installation

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

- If you have a `sublime-text.docset.tgz` from GitHub, extract it somewhere.
- 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.

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

### Install a local folder to Dash

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

1. Open Dash.
1. <kbd>Cmd</kbd>+<kbd>,</kbd>
1. Open the "Docsets" tab.
Expand All @@ -25,9 +28,6 @@ We hope to have a distribution channel [eventually][distribution].
1. Optionally change the keyword.
1. Repeat for `out/sublime-merge.docset`.

It may be possible to just double-click `sublime-text.docset`,
but that hasn't been tested.

### Install a local folder to Zeal

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