Merge pull request #16 from michaelblyons/st4

Update for new(er) Docs site

Author: michaelblyons

.github/workflows/build.yml

@@ -0,0 +1,34 @@
+name: Build
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    timeout-minutes: 15
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Go
+        uses: actions/setup-go@v5
+
+      - name: Install Dashing
+        run: go install github.com/technosophos/dashing@latest
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.13
+
+      - name: Install Python dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+
+      - name: Build the docset
+        run: make
+
+      - name: Upload the docset
+        uses: actions/upload-artifact@v4
+        with:
+          name: sublime-text.docset
+          path: www.sublimetext.com/sublime-text.docset

.gitignore

@@ -1 +1 @@
-*/
+/www.sublimetext.com/

Makefile

@@ -1,7 +1,7 @@
 source_link := https://www.sublimetext.com/docs/index.html
-local_path := ./www.sublimetext.com
+local_path := www.sublimetext.com
 local_index := $(local_path)/docs/index.html
-built_path := ./sublime-text.docset
+built_path := $(local_path)/sublime-text.docset
 
 .PHONY: all
 all: clean download pre-build build post-build
@@ -21,15 +21,17 @@ pre-build: fix-html fix-css
 
 .PHONY: fix-html
 fix-html:
-	find $(local_path) -iname '*.html' -exec sed -i -e '/<header>/,/<\/header>/d' {} \;
-	python prefix_methods.py
+	python fix_html.py
 
 .PHONY: fix-css
 fix-css:
-	$(shell for f in $$(ls $(local_path)/*.css\?*); do mv "$$f" "$${f%\?*}"; done )
+	$(shell for f in $$(ls $(local_path)/*.*\?*); do mv "$$f" "$${f%\?*}"; done )
+	$(shell for f in $$(ls $(local_path)/**/*.*\?*); do mv "$$f" "$${f%\?*}"; done )
 
 build:
-	dashing build
+	yq -j . dashing.yml > $(local_path)/dashing.json
+	cd $(local_path) \
+	&& dashing build
 
 .PHONY: post-build
 post-build:

README.md

@@ -1,14 +1,46 @@
-# Sublime Text Docset
+# [Sublime Text Docset][self]
+
+[Dash][] and [Zeal][] docset for [Sublime Text][st]’s official
+[documentation][st-docs].
+
+
+## Installation
+
+Download from GitHub Releases or build yourself with the instructions below.
+
+- If you have a `sublime-text.docset.zip` from GitHub, extract it to a
+folder called `sublime-text.docset`.
+- If you build yourself, `sublime-text.docset` will be in the
+`www.sublimetext.com` folder.
+
+We hope to have a distribution channel [eventually][distribution].
+
+### Install a local folder to Dash
+
+1. Open Dash.
+1. <kbd>Cmd</kbd>+<kbd>,</kbd>
+1. Open the "Docsets" tab.
+1. Click the <kbd>+</kbd>.
+1. Choose "Add Local Docset".
+1. Select the `sublime-text.docset` in the `www.sublimetext.com` folder.
+1. Optionally change the keyword.
+
+###  Install a local folder to Zeal
+
+1. Find your docset folder ("Docset storage" in your Preferences)
+1. Copy or symlink `sublime-text.docset` to that folder.
 
-[Dash][]/[Zeal][] docset for [Sublime Text][st]’s official [documentation][st-docs].
 
 ## Building
 
 ### Requirements
 
 * `make`
 * [`dashing`][dashing]
-* `sed` (with `-E` support), `find`, `wget`
+* `yq`
+* `sed` (with `-E` support)
+* `find`
+* `wget`
 * Python 3.8+
 
 ### Steps
@@ -20,25 +52,11 @@
    make
    ```
 
-## Installation
-
-### Dash locally-built docset
-
-1. Open Dash.
-1. <kbd>Cmd</kbd>+<kbd>,</kbd>
-1. Open the "Docsets" tab.
-1. Click the <kbd>+</kbd>.
-1. Choose "Add Local Docset".
-1. Select the `sublime-text.docset` in this folder.
-1. Optionally change the keyword.
-
-### Zeal locally-built docset
-
-1. Find your docset folder ("Docset storage" in your Preferences)
-1. Copy or symlink `sublime-text.docset` to that folder.
 
+[self]: https://github.com/SublimeText/sublime-text-docset
 [Dash]: https://kapeli.com/dash
 [Zeal]: https://zealdocs.org
 [st]: https://www.sublimetext.com/
 [st-docs]: https://www.sublimetext.com/docs/index.html
 [dashing]: https://github.com/technosophos/dashing#readme
+[distribution]: https://github.com/SublimeText/sublime-text-docset/issues/12