docs: update instructions to create subfolders to deploy in gh-pages

mauriciopoppe · Mar 9, 2024 · 8369b13 · 8369b13
1 parent f47431d
commit 8369b13
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 6 deletions.
diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md
@@ -20,11 +20,14 @@ npm run test
 
 ## Deployment
 
-Deploy steps:
+Website deployment steps:
 
-- `npm run deploy`
+- `npm run build`
+- Choose a location to release to:
+  - Deploy master: `./node_modules/.bin/gh-pages --dist site --dest master`
+  - Deploy a tag: `./node_modules/.bin/gh-pages --dist site --dest <tag>`
 
 Release steps:
 
-- Do deploy steps first
+- `npm run build`
 - `np major|minor|patch`
diff --git a/package.json b/package.json
@@ -21,9 +21,7 @@
   },
   "types": "./dist/index.d.ts",
   "scripts": {
-    "predeploy": "npm run build",
-    "deploy": "gh-pages -d site",
-    "html": "node site.cjs",
+    "html": "node scripts/generate-examples.cjs",
     "build": "npx rimraf dist && npm run html && npm run docs && npm run build:typescript && npm run build:webpack && npm run build:site",
     "build:webpack": "NODE_ENV=production webpack",
     "build:typescript": "tsc && cp src/samplers/*.mjs dist/samplers/",

diff --git a/site.cjs → scripts/generate-examples.cjs b/site.cjs → scripts/generate-examples.cjs