Merge pull request #4254 from ralfhandl/dev-build-src

dev: build HTML from src/oas.md

Author: handrews

.gitignore

@@ -6,6 +6,7 @@ target
 atlassian-ide-plugin.xml
 node_modules/
 deploy/
+deploy-preview/
 coverage/
 history
 Gemfile.lock

CONTRIBUTING.md

@@ -163,6 +163,21 @@ This might apply to, for example, Markdown files, automation, and scripts.
 For all pull requests, if they should not be merged yet for any reason (they depend on something else, you would like feedback from a specific reviewer), mark them as draft and they will not be merged while in that state.
 Draft pull requests can still be reviewed while in draft state.
 
+### Preview specification HTML locally
+
+The markdown source files are converted to HTML before publishing.
+To do this locally, please
+
+1. Install [Node.js](https://nodejs.org/)
+2. Check out this repo, go to the repo root, and switch to a development branch
+3. Execute `npm install` (once, repeat after merging upstream changes)
+4. Execute `npm run build-src` after changing `src/oas.md` 
+5. Open output file `deploy-preview/oas.html` with a browser
+
+Before creating a pull request or marking a draft pull request as ready for review, please
+
+6. Execute `npm run validate-markdown` and fix any reported problems in `src/oas.md`
+
 ## Reviewers
 
 > [!NOTE]

package.json

@@ -14,6 +14,7 @@
   "license": "Apache-2.0",
   "scripts": {
     "build": "bash ./scripts/md2html/build.sh",
+    "build-src": "bash ./scripts/md2html/build-src.sh",
     "test": "c8 --100 vitest --watch=false && bash scripts/schema-test-coverage.sh",
     "validate-markdown": "npx mdv src/oas.md && npx markdownlint-cli src/oas.md"
   },

scripts/md2html/build-src.sh

@@ -0,0 +1,26 @@
+#!/usr/bin/env bash
+
+# Author: @ralfhandl
+
+# run this script from the root of the repo
+
+mkdir -p deploy-preview/temp
+mkdir -p deploy-preview/js
+
+cp -p node_modules/respec/builds/respec-w3c.* deploy-preview/js/
+
+cd scripts/md2html
+
+filename=src/oas.md
+tempfile=../../deploy-preview/temp/oas.html
+echo "=== ${filename} ==="
+
+node md2html.js --maintainers ../../EDITORS.md ../../${filename} > $tempfile
+npx respec --use-local --src $tempfile --out ../../deploy-preview/oas.html
+rm $tempfile
+
+echo Built deploy-preview/oas.html
+echo
+
+rm -r ../../deploy-preview/js
+rmdir ../../deploy-preview/temp