Move the doc site download to a submodule (#18)

Ali Ayas has already made a clean version, and we can guarantee consistent output by relying on certain versions of the site.

Author: michaelblyons

.github/dependabot.yml

@@ -0,0 +1,13 @@
+# https://docs.github.com/en/code-security/dependabot/working-with-dependabot/dependabot-options-reference
+
+# Source - https://stackoverflow.com/a/73229032
+# Posted by aknosis
+# Retrieved 2025-11-07, License - CC BY-SA 4.0
+
+version: 2
+
+updates:
+  - package-ecosystem: gitsubmodule
+    schedule:
+        interval: daily
+    directory: /

.github/workflows/build.yml

@@ -7,6 +7,8 @@ jobs:
     timeout-minutes: 15
     steps:
       - uses: actions/checkout@v4
+        with:
+          submodules: true
 
       - name: Setup Go
         uses: actions/setup-go@v5
@@ -31,4 +33,4 @@ jobs:
         uses: actions/upload-artifact@v4
         with:
           name: sublime-text.docset
-          path: www.sublimetext.com/sublime-text.docset
+          path: SublimeText_Documentation/www.sublimetext.com/sublime-text.docset

.gitignore

@@ -0,0 +1,4 @@
+[submodule "SublimeText_Documentation"]
+	path = SublimeText_Documentation
+	url = https://github.com/maliayas/SublimeText_Documentation
+	ignore = dirty

.gitmodules

@@ -1,42 +1,27 @@
-source_link := https://www.sublimetext.com/docs/index.html
-local_path := www.sublimetext.com
+submodule_path := SublimeText_Documentation
+local_path := $(submodule_path)/www.sublimetext.com
 local_index := $(local_path)/docs/index.html
-built_path := $(local_path)/sublime-text.docset
+docset := sublime-text.docset
+dashing_json := $(local_path)/dashing.json
+built_path := $(local_path)/$(docset)
 
 .PHONY: all
-all: clean download pre-build build
-
-.PHONY: download
-download:
-	-wget \
-		--convert-links \
-		--recursive \
-		--page-requisites \
-		--no-parent \
-		--timestamping \
-		"$(source_link)"
+all: clean pre-build build
 
 .PHONY: fix
-pre-build: fix-html fix-css
+pre-build: fix-html
 
 .PHONY: fix-html
 fix-html:
 	python fix_html.py
 
-.PHONY: fix-css
-fix-css:
-	$(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:
-	yq -j . dashing.yml > $(local_path)/dashing.json
+	yq -j . dashing.yml > $(dashing_json)
 	cd $(local_path) \
 	&& dashing build
 
 .PHONY: clean
 clean:
-	-rm -r $(local_path)
-
-.PHONY: clean-more
-clean-more: clean
-	-rm -r $(built_path)
+	[ -d "$(built_path)" ] && rm -r $(built_path) || true
+	[ -f "$(dashing_json)" ] && rm $(dashing_json) || true
+	git restore $(submodule_path) --recurse-submodules

Makefile

@@ -38,7 +38,6 @@ We hope to have a distribution channel [eventually][distribution].
 * `make`
 * [`dashing`][dashing]
 * `yq`
-* `wget`
 * Python 3.8+
 
 ### Steps

README.md

@@ -1,9 +1,9 @@
 name: Sublime Text
 package: sublime-text
-index: www.sublimetext.com/docs/index.html
-icon32x32: favicon.png
+index: docs/index.html
+icon32x32: ../../favicon.png
 allowJS: false
-ExternalURL: ''
+ExternalURL: 'https://www.sublimetext.com'
 ignore:
   - id
   - id0

SublimeText_Documentation

@@ -8,7 +8,7 @@
 
 from bs4 import BeautifulSoup
 
-DOC_ROOT = 'www.sublimetext.com/docs'
+DOC_ROOT = 'SublimeText_Documentation/www.sublimetext.com/docs'
 
 
 def delete_skins(soup):