From 008c8ba417c559e2ea9105dbb38b513a168ceda2 Mon Sep 17 00:00:00 2001 From: Deyan Ginev Date: Sun, 5 Jul 2026 11:05:57 -0400 Subject: [PATCH] docs: point CDN URLs at jsDelivr /gh/ endpoint (npm publish now optional) 0.9.0 was tagged but not published to npm, so the /npm/ jsDelivr URLs and unpkg 404. jsDelivr's GitHub endpoint serves the bundle straight from the pushed tag and is already live (verified @0.9.0/@0.9/@0/@latest all 200). - README Quick start + THEMING CDN recipe now use cdn.jsdelivr.net/gh/dginev/ar5iv-css@/... - Reframe npm publish as optional/additive (enables /npm/ mirror + unpkg + npm install) in README Quick start, Releasing notes, and CHANGELOG. - Drop the unpkg drop-in line (unpkg is npm-only). Co-Authored-By: Claude Opus 4.8 (1M context) --- CHANGELOG.md | 3 ++- README.md | 44 ++++++++++++++++++++++++++------------------ docs/THEMING.md | 2 +- 3 files changed, 29 insertions(+), 20 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 9712cdc..79bb2a8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -27,7 +27,8 @@ First public npm/CDN release of the "glowup" rework. Highlights: - **Print styles** — forced light theme, inline footnote content, external-URL expansion, block-integrity hints. - **Minified bundle** — `dist/ar5iv.min.css`, committed and served via - jsDelivr/unpkg; verified against a fresh build in CI on tag push. + jsDelivr's `/gh/` endpoint straight from the tag; verified against a + fresh build in CI on tag push. - Docs: `THEMING.md`, `TOKENS.md`, `BASELINE_AUDIT.md`, `SVG_BOXES.md`; `CONTRIBUTING.md`; stylelint config; visual-regression harness. diff --git a/README.md b/README.md index 8d4e5e7..8a7e2e8 100644 --- a/README.md +++ b/README.md @@ -6,22 +6,25 @@ The "ar5iv theme" for arXiv HTML documents converted via LaTeXML. ### CDN (recommended for production) -After a tagged release lands on npm, jsDelivr and unpkg auto-serve -the built minified bundle. No CDN sign-up or configuration needed. +jsDelivr serves the built bundle directly from the git release tag via +its GitHub endpoint — no npm publish, CDN sign-up, or configuration +needed. ```html + href="https://cdn.jsdelivr.net/gh/dginev/ar5iv-css@0.9.0/css/ar5iv-fonts.css"> + href="https://cdn.jsdelivr.net/gh/dginev/ar5iv-css@0.9.0/dist/ar5iv.min.css"> ``` -unpkg is a drop-in alternative: -`https://unpkg.com/ar5iv-css@0.9.0/dist/ar5iv.min.css`. - Pin the version (`@0.9.0`) for reproducibility. Use `@0.9` for the -latest patch within a minor or `@latest` if you want the bleeding -edge — at the cost of cache poisoning on version bumps. +latest patch within a minor, or `@latest` for the newest tag — at the +cost of cache poisoning on version bumps. + +> The `/gh/` endpoint is served straight from the tagged commit, so it +> works the moment the tag is pushed. Publishing to npm is optional; if +> done, the `/npm/` mirror (`cdn.jsdelivr.net/npm/ar5iv-css@…`), unpkg, +> and `npm install ar5iv-css` become available too. ### Self-hosted from a git checkout @@ -93,16 +96,21 @@ npm run lint # stylelint + TOKENS.md drift (the prevers npm run build # refresh dist/ git add -A && git commit -m "release: 0.9.0" git tag 0.9.0 # UNPREFIXED -git push origin HEAD --follow-tags -npm publish # prepublishOnly re-runs the build +git push origin HEAD --follow-tags # tag push -> /gh/ CDN goes live via release.yml +# npm publish # OPTIONAL: also enables /npm/ + unpkg + npm install ``` For subsequent releases, prefer `npm version `: its `version` lifecycle rebuilds and stages `dist/`, and `postversion` -pushes the commit and tag; then `npm publish`. - -The published artefact contains both the unminified source (`css/`) -and the minified bundle (`dist/`). Pushing the tag runs `release.yml`, -which re-verifies the committed `dist/` against a fresh build and -warms the jsDelivr cache. jsDelivr and unpkg mirror the npm release -within minutes — no further action required. +pushes the commit and tag. + +Pushing the tag runs `release.yml`, which re-verifies the committed +`dist/` against a fresh build and warms jsDelivr's `/gh/` cache — so +the CDN URLs above go live directly from the tag, no npm publish +required. + +Publishing to npm is optional and additive: `npm publish` (which the +`prepublishOnly` script builds for) also enables the `/npm/` jsDelivr +mirror, unpkg, and `npm install ar5iv-css`. The published artefact +contains both the unminified source (`css/`) and the minified bundle +(`dist/`). diff --git a/docs/THEMING.md b/docs/THEMING.md index 2a42dca..48a2ae0 100644 --- a/docs/THEMING.md +++ b/docs/THEMING.md @@ -277,7 +277,7 @@ non-emergency overrides. ```html + href="https://cdn.jsdelivr.net/gh/dginev/ar5iv-css@0.9.0/dist/ar5iv.min.css"> ```